GetSmallIcon Method

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.

GetSmallIcon(String, Float)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(string identifier, float dpi);

​Public Shared Function GetSmallIcon(ByVal identifier As String, ByVal dpi As Single) As System.Drawing.Bitmap

GetSmallIcon(String, Float, Windows.Forms.ResourceProvider.ImageSourceSettings)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(string identifier, float dpi, Windows.Forms.ResourceProvider.ImageSourceSettings settings);

​Public Shared Function GetSmallIcon(ByVal identifier As String, ByVal dpi As Single, ByVal settings As Windows.Forms.ResourceProvider.ImageSourceSettings) As System.Drawing.Bitmap

GetSmallIcon(System.IO.Stream, Float)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(System.IO.Stream stream, float dpi);

​Public Shared Function GetSmallIcon(ByVal stream As System.IO.Stream, ByVal dpi As Single) As System.Drawing.Bitmap

GetSmallIcon(String, System.Windows.Forms.Control)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(string identifier, System.Windows.Forms.Control control);

​Public Shared Function GetSmallIcon(ByVal identifier As String, ByVal control As System.Windows.Forms.Control) As System.Drawing.Bitmap

GetSmallIcon(String, System.Windows.Forms.Control, Windows.Forms.ResourceProvider.ImageSourceSettings)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(string identifier, System.Windows.Forms.Control control, Windows.Forms.ResourceProvider.ImageSourceSettings settings);

​Public Shared Function GetSmallIcon(ByVal identifier As String, ByVal control As System.Windows.Forms.Control, ByVal settings As Windows.Forms.ResourceProvider.ImageSourceSettings) As System.Drawing.Bitmap

GetSmallIcon(System.IO.Stream, System.Windows.Forms.Control)

• C#
• VB.NET

​public static System.Drawing.Bitmap GetSmallIcon(System.IO.Stream stream, System.Windows.Forms.Control control);

​Public Shared Function GetSmallIcon(ByVal stream As System.IO.Stream, ByVal control As System.Windows.Forms.Control) As System.Drawing.Bitmap

Parameters

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.

Further Reading

Learn more about the TXTextControl.Windows.Forms.ResourceProvider.GetSmallIcon Method in the Text Control Blog:

• Using the ResourceProvider to Customize the Ribbon MiniToolbar