IconExtensions.ExtractBitmap Method (Icon, Boolean)

KGy SOFT Drawing Libraries

previous page next page


IconExtensionsExtractBitmap Method (Icon, Boolean)	KGy SOFT Drawing Libraries Help

Extracts the first image from an Icon instance. If the icon has only one image consider to use ToAlphaBitmap, which is faster.

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

Syntax

C++

Copy

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

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

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

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

Parameters

icon: Type: System.DrawingIcon
The icon that may contain multiple images.
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 no image was found in the icon.

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

Reference

IconExtensions Class

ExtractBitmap Overload

KGySoft.Drawing Namespace

IconExtensionsToAlphaBitmap(Icon)

Find the complete KGy SOFT Libraries documentation at the KGy SOFT Docs page.

previous page start next page