IconExtensionsExtractBitmaps(Icon, PixelFormat, Boolean) Method

Extracts every image of specified pixel format from an Icon instance.

Definition

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

C#

public static Bitmap?[] ExtractBitmaps(
	this Icon icon,
	PixelFormat pixelFormat,
	bool keepOriginalFormat = false
)

VB

<ExtensionAttribute>
Public Shared Function ExtractBitmaps ( 
	icon As Icon,
	pixelFormat As PixelFormat,
	Optional keepOriginalFormat As Boolean = false
) As Bitmap()

C++

public:
[ExtensionAttribute]
static array<Bitmap^>^ ExtractBitmaps(
	Icon^ icon, 
	PixelFormat pixelFormat, 
	bool keepOriginalFormat = false
)

F#

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

Parameters

icon Icon: The icon that may contain multiple images.
pixelFormat PixelFormat: The required pixel format 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 array of Bitmap instances, which were extracted from the icon. On Windows the result never has elements

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 non-Windows platforms the result may contain elements in place of very large uncompressed icons.