IconExtensionsExtractIcon(Icon, Size, PixelFormat) Method

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

Definition

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

C#

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

VB

<ExtensionAttribute>
Public Shared Function ExtractIcon ( 
	icon As Icon,
	size As Size,
	pixelFormat As PixelFormat
) As Icon

C++

public:
[ExtensionAttribute]
static Icon^ ExtractIcon(
	Icon^ icon, 
	Size size, 
	PixelFormat pixelFormat
)

F#

[<ExtensionAttribute>]
static member ExtractIcon : 
        icon : Icon * 
        size : Size * 
        pixelFormat : PixelFormat -> Icon

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

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

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

Note

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