GetLargeIcon Method

Description

Gets a System.Windows.Media.Imaging.BitmapSource of the large 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 large icon depends on the resolution that is specified by the dpi parameter or a specific framework element. The source of the large image is based on a grid of 32x32 Pixel and a resolution of 96 dpi.

Syntax

GetLargeIcon(string, double)

Gets a System.Windows.Media.Imaging.BitmapSource of the large icon that is associated with the specified identifier in a specific resolution.

public static BitmapSource GetLargeIcon(string identifier, double dpi);

Public Shared Function GetLargeIcon(identifier As String, dpi As Double) As BitmapSource

GetLargeIcon(string, double, ResourceProvider.ImageSourceSettings)

Gets a System.Windows.Media.Imaging.BitmapSource of the large icon that is associated with the specified identifier in a specific resolution and additional image source settings.

public static BitmapSource GetLargeIcon(string identifier, double dpi, ResourceProvider.ImageSourceSettings settings);

Public Shared Function GetLargeIcon(identifier As String, dpi As Double, settings As ResourceProvider.ImageSourceSettings) As BitmapSource

GetLargeIcon(Stream, float)

Gets a large System.Windows.Media.Imaging.BitmapSource icon that is created from a Scalable Vector Graphics (SVG) stream in a specific resolution.

public static BitmapSource GetLargeIcon(Stream stream, float dpi);

Public Shared Function GetLargeIcon(stream As Stream, dpi As Single) As BitmapSource

GetLargeIcon(string, FrameworkElement)

Gets a System.Windows.Media.Imaging.BitmapSource of the large icon that is associated with the specified identifier in the resolution of a specific framework element.

public static BitmapSource GetLargeIcon(string identifier, FrameworkElement frameworkElement);

Public Shared Function GetLargeIcon(identifier As String, frameworkElement As FrameworkElement) As BitmapSource

GetLargeIcon(string, FrameworkElement, ResourceProvider.ImageSourceSettings)

Gets a System.Windows.Media.Imaging.BitmapSource of the large icon that is associated with the specified identifier in the resolution of a specific framework element and additional image source settings.

public static BitmapSource GetLargeIcon(string identifier, FrameworkElement frameworkElement, ResourceProvider.ImageSourceSettings settings);

Public Shared Function GetLargeIcon(identifier As String, frameworkElement As FrameworkElement, settings As ResourceProvider.ImageSourceSettings) As BitmapSource

GetLargeIcon(Stream, FrameworkElement)

Gets a large System.Windows.Media.Imaging.BitmapSource icon that is created from a Scalable Vector Graphics (SVG) stream in the resolution of the specified framework element.

public static BitmapSource GetLargeIcon(Stream stream, FrameworkElement frameworkElement);

Public Shared Function GetLargeIcon(stream As Stream, frameworkElement As FrameworkElement) As BitmapSource

Return Value

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

Examples

The following example retrieves large icon from the resource provider.

var result = TXTextControl.WPF.ResourceProvider.GetLargeIcon("Quarterly report", new System.Windows.FrameworkElement());
Console.WriteLine($"Get Large Icon result: {result}");

Dim result = TXTextControl.WPF.ResourceProvider.GetLargeIcon("Quarterly report", New System.Windows.FrameworkElement())
Console.WriteLine($"Get Large Icon result: {result}")

Remarks

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