IconExtensionsExtractBitmap(Icon, Int32, Boolean) Method

Extracts the image of specified index from an Icon instance.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.0.0-rc.1

C#

public static Bitmap? ExtractBitmap(
	this Icon icon,
	int index,
	bool keepOriginalFormat = false
)

VB

<ExtensionAttribute>
Public Shared Function ExtractBitmap ( 
	icon As Icon,
	index As Integer,
	Optional keepOriginalFormat As Boolean = false
) As Bitmap

C++

public:
[ExtensionAttribute]
static Bitmap^ ExtractBitmap(
	Icon^ icon, 
	int index, 
	bool keepOriginalFormat = false
)

F#

[<ExtensionAttribute>]
static member ExtractBitmap : 
        icon : Icon * 
        index : int * 
        ?keepOriginalFormat : bool 
(* Defaults:
        let _keepOriginalFormat = defaultArg keepOriginalFormat false
*)
-> Bitmap

Parameters

icon Icon: The icon that may contain multiple images.
index Int32: The zero-based index of the icon image to retrieve.
keepOriginalFormat Boolean (Optional): If , keeps the original image format stored in the icon. Possible transparent pixels of non-32 bpp ARGB formats may be black. If , always returns 32 bpp images with transparency. This parameter is optional.
Default value: .

Return Value

Bitmap
An Bitmap instance, which was extracted from the icon, 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).

Remarks

Note

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