IconExtensionsExtractIcon Method (Icon, Int32, Boolean)

KGy SOFT Drawing Libraries Help
Extracts the icon of specified index from an Icon instance.

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

public static Icon ExtractIcon(
	this Icon icon,
	int index,
	bool forceUncompressedResult


Type: System.DrawingIcon
The icon that may contain multiple images.
Type: SystemInt32
The zero-based index of the icon image to retrieve.
Type: SystemBoolean
 to force returning an uncompressed icon;  to allow PNG compression, which is supported by Windows Vista and above.

Return Value

Type: Icon
An Icon instance, which contains only a single image, or  if the specified index was too large.

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).

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