IconExtensionsCombine(Icon, Bitmap, Boolean) Method

Combines an Icon instance with the provided image into a multi-resolution Icon instance.

Definition

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

C#

public static Icon Combine(
	this Icon icon,
	Bitmap? image,
	bool forceUncompressedResult
)

VB

<ExtensionAttribute>
Public Shared Function Combine ( 
	icon As Icon,
	image As Bitmap,
	forceUncompressedResult As Boolean
) As Icon

C++

public:
[ExtensionAttribute]
static Icon^ Combine(
	Icon^ icon, 
	Bitmap^ image, 
	bool forceUncompressedResult
)

F#

[<ExtensionAttribute>]
static member Combine : 
        icon : Icon * 
        image : Bitmap * 
        forceUncompressedResult : bool -> Icon

Parameters

icon Icon: The icon to combine with other images.
image Bitmap: The image to be added to the icon. Can be a non-squared one.
forceUncompressedResult Boolean: to force returning an uncompressed icon; to allow PNG compression, which is supported by Windows Vista and above.

Return Value

Icon
An Icon instance that contains the source image.

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

Both icon and image may contain multiple icons.

This overload attempts to reduce the color depth of the added icon image losslessly if possible. To prevent that, use the Combine(Icon, Bitmap, Color, Boolean) overload instead.