IconExtensions.ExtractBitmap Method (Icon, Int32, Boolean)

KGy SOFT Drawing Libraries

previous page next page
IconExtensionsExtractBitmap Method (Icon, Int32, Boolean) KGy SOFT Drawing Libraries Help
Extracts the image of specified index from an Icon instance.

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 4.6.1
Syntax
Copy
public static Bitmap ExtractBitmap(
	this Icon icon,
	int index,
	bool keepOriginalFormat = false
)
<ExtensionAttribute>
Public Shared Function ExtractBitmap ( 
	icon As Icon,
	index As Integer,
	Optional keepOriginalFormat As Boolean = false
) As Bitmap
public:
[ExtensionAttribute]
static Bitmap^ ExtractBitmap(
	Icon^ icon, 
	int index, 
	bool keepOriginalFormat = false
)
[<ExtensionAttribute>]
static member ExtractBitmap : 
        icon : Icon * 
        index : int * 
        ?keepOriginalFormat : bool 
(* Defaults:
        let _keepOriginalFormat = defaultArg keepOriginalFormat false
*)
-> Bitmap

Parameters

icon
Type: System.DrawingIcon
The icon that may contain multiple images.
index
Type: SystemInt32
The zero-based index of the icon image to retrieve.
keepOriginalFormat (Optional)
Type: SystemBoolean
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

Type: 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).
See Also

Reference

IconExtensions Class
ExtractBitmap Overload
KGySoft.Drawing Namespace
IconExtensionsExtractIcon(Icon, Int32)
previous page start next page