IconExtensionsExtractNearestIcon(Icon, Size, PixelFormat) Method

Extracts the nearest icon of specified size and pixel format from an Icon instance. Unless the Icon constructors, this method works as expected.

Definition

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

C#

public static Icon ExtractNearestIcon(
	this Icon icon,
	Size size,
	PixelFormat pixelFormat
)

VB

<ExtensionAttribute>
Public Shared Function ExtractNearestIcon ( 
	icon As Icon,
	size As Size,
	pixelFormat As PixelFormat
) As Icon

C++

public:
[ExtensionAttribute]
static Icon^ ExtractNearestIcon(
	Icon^ icon, 
	Size size, 
	PixelFormat pixelFormat
)

F#

[<ExtensionAttribute>]
static member ExtractNearestIcon : 
        icon : Icon * 
        size : Size * 
        pixelFormat : PixelFormat -> Icon

Parameters

icon Icon: The icon that may contain multiple images.
size Size: The required icon size to retrieve.
pixelFormat PixelFormat: The required pixel format to retrieve

Return Value

Icon
An Icon instance, which contains only a single image. If no icon was found with the specified size and format the nearest icon (size match has preference over pixelFormat) is returned.

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

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

On some platforms it may happen that a smaller icon is returned than requested size if the requested icon size is not supported. If icon contains only unsupported icon sizes, then is returned.

To force a result exactly with the specified size, use the Resize method instead.