IconExtensions.ExtractNearestIcon Method

KGy SOFT Drawing Libraries


IconExtensionsExtractNearestIcon Method	KGy SOFT Drawing Libraries Help

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

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

Syntax

C++

Copy

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

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

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

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

Parameters

icon: Type: System.DrawingIcon
The icon that may contain multiple images.
size: Type: System.DrawingSize
The required icon size to retrieve.
pixelFormat: Type: System.Drawing.ImagingPixelFormat
The required pixel format to retrieve

Return Value

Type: Icon
An Icon instance, which contains only a single image. If no icon was found with the specified size and format the nearest icon (pixelFormat matches first, then size) 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).

Reference

IconExtensions Class

KGySoft.Drawing Namespace

IconExtensionsExtractNearestBitmap(Icon, Size, PixelFormat, Boolean)

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

previous page start next page