GetSmallIcon Method

Description

Gets a System.Drawing.Bitmap of the small icon that is associated with an item and specified by an identifier or a Scalable Vector Graphics (SVG) stream parameter. The identifier can be the string conversion of an enumeration that is associated with an item (such as RibbonFormattingTab.RibbonItem.TXITEM_Paste). The size of the returned small icon depends on the resolution that is specified by the dpi parameter or the resolution of a specific control. The source of the small image is based on a grid of 16x16 Pixel and a resolution of 96 dpi.

Syntax

GetSmallIcon(string, float)

Gets a System.Drawing.Bitmap of the small icon that is associated with the specified identifier in a specific resolution.

public static Bitmap GetSmallIcon(string identifier, float dpi);

Public Shared Function GetSmallIcon(identifier As String, dpi As Single) As Bitmap

GetSmallIcon(string, float, ResourceProvider.ImageSourceSettings)

Gets a System.Drawing.Bitmap of the small icon that is associated with the specified identifier in a specific resolution and additional image source settings.

public static Bitmap GetSmallIcon(string identifier, float dpi, ResourceProvider.ImageSourceSettings settings);

Public Shared Function GetSmallIcon(identifier As String, dpi As Single, settings As ResourceProvider.ImageSourceSettings) As Bitmap

GetSmallIcon(Stream, float)

Gets a small System.Drawing.Bitmap icon that is created from a Scalable Vector Graphics (SVG) stream in a specific resolution .

public static Bitmap GetSmallIcon(Stream stream, float dpi);

Public Shared Function GetSmallIcon(stream As Stream, dpi As Single) As Bitmap

GetSmallIcon(string, Control)

Gets a System.Drawing.Bitmap of the small icon that is associated with the specified identifier in the resolution of a specific control.

public static Bitmap GetSmallIcon(string identifier, Control control);

Public Shared Function GetSmallIcon(identifier As String, control As Control) As Bitmap

GetSmallIcon(string, Control, ResourceProvider.ImageSourceSettings)

Gets a System.Drawing.Bitmap of the small icon that is associated with the specified identifier in the resolution of a specific control and additional image source settings.

public static Bitmap GetSmallIcon(string identifier, Control control, ResourceProvider.ImageSourceSettings settings);

Public Shared Function GetSmallIcon(identifier As String, control As Control, settings As ResourceProvider.ImageSourceSettings) As Bitmap

GetSmallIcon(Stream, Control)

Gets a small System.Drawing.Bitmap icon that is created from a Scalable Vector Graphics (SVG) stream in the resolution of the specified control.

public static Bitmap GetSmallIcon(Stream stream, Control control);

Public Shared Function GetSmallIcon(stream As Stream, control As Control) As Bitmap

Return Value

A bitmap of the small icon that is assigned to the item. If no small icon is associated with the item, the method returns null.

Examples

The following example retrieves small icon from the resource provider.

var result = TXTextControl.Windows.Forms.ResourceProvider.GetSmallIcon("Quarterly report", new System.Windows.Forms.Control());
Console.WriteLine($"Get Small Icon result: {result}");

Dim result = TXTextControl.Windows.Forms.ResourceProvider.GetSmallIcon("Quarterly report", New System.Windows.Forms.Control())
Console.WriteLine($"Get Small Icon result: {result}")

Remarks

An exception is thrown if the handle of the specified control parameter is not created.

Further Reading

• Using the ResourceProvider to Customize the Ribbon MiniToolbar – July 10, 2019