Gets a System.Windows.Media.Imaging.BitmapSource of the small icon that is associated with an item and specified by an identifier or 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 a specific framework element. The source of the small image is based on a grid of 16x16 Pixel and a resolution of 96 dpi.

GetSmallIcon(String, Double)

public static System.Windows.Media.Imaging.BitmapSource GetSmallIcon(string identifier, double dpi);

GetSmallIcon(String, Double, WPF.ResourceProvider.ImageSourceSettings)

public static System.Windows.Media.Imaging.BitmapSource GetSmallIcon(string identifier, double dpi, WPF.ResourceProvider.ImageSourceSettings settings);

GetSmallIcon(System.IO.Stream, Float)

public static System.Windows.Media.Imaging.BitmapSource GetSmallIcon(System.IO.Stream stream, float dpi);

GetSmallIcon(String, System.Windows.FrameworkElement)

public static System.Windows.Media.Imaging.BitmapSource GetSmallIcon(string identifier, System.Windows.FrameworkElement frameworkElement);

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

public static System.Windows.Media.Imaging.BitmapSource GetSmallIcon(string identifier, System.Windows.FrameworkElement frameworkElement, Windows.Forms.ResourceProvider.ImageSourceSettings settings);

GetSmallIcon(System.IO.Stream, System.Windows.FrameworkElement)

public static System.Drawing.Bitmap GetSmallIcon(System.IO.Stream stream, System.Windows.FrameworkElement frameworkElement);

Parameters

Parameter Description
identifier The identifier of the item that is associated with the requested small icon.
dpi Specifies the resolution that is used to create the requested small icon.
settings Specifies an ImageSourceSettings object with additional settings for receiving the small image.
frameworkElement Specifies the framework element from where the resolution is determined that is used to create the requested small icon.
stream Specifies the Scalable Vector Graphics (SVG) stream that is used to create the requested small icon.

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.

Remarks

An exception is thrown if the instance of the specified frameworkElement parameter is not loaded.