IconExtensionsExtractIcon Method (Icon, Size, PixelFormat)

KGy SOFT Drawing Libraries Help
Extracts the icon of specified size and pixel format from an Icon instance. Unless the Icon constructors, this method works as expected.

Namespace:  KGySoft.Drawing
Assembly:  KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 5.3.0
Syntax

public static Icon ExtractIcon(
	this Icon icon,
	Size size,
	PixelFormat pixelFormat
)

Parameters

icon
Type: System.DrawingIcon
The icon that may contain multiple images.
size
Type: System.DrawingSize
The required icon size to retrieve.
pixelFormat
Type: System.Drawing.ImagingPixelFormat
The required pixel format to retrieve

Return Value

Type: Icon
An Icon instance, which contains only a single image, or  if no icon found with the specified size and format.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Icon. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks

The result Icon instances are compatible with Windows XP if the method is executed in a Windows XP environment.

Note Note
On some platforms this method may throw a PlatformNotSupportedException for very large icons.
See Also

Reference