IconExtensionsCombine(Icon, Bitmap) Method

Combines an Icon instance with the provided images 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,
	params Bitmap[]? images
)

VB

<ExtensionAttribute>
Public Shared Function Combine ( 
	icon As Icon,
	ParamArray images As Bitmap()
) As Icon

C++

public:
[ExtensionAttribute]
static Icon^ Combine(
	Icon^ icon, 
	... array<Bitmap^>^ images
)

F#

[<ExtensionAttribute>]
static member Combine : 
        icon : Icon * 
        images : Bitmap[] -> Icon

Parameters

icon Icon: The icon to combine with other images.
images Bitmap: The images to be added to the icon. Images can be non-squared ones.

Return Value

Icon
An Icon instance that contains every image of the source images.

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 elements of images may contain multiple icons.

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

The result Icon is compatible with Windows XP if the method is executed in a Windows XP environment.