ThumbnailImageEventArgs.CreateThumbnailImage(Image, Size) Method

Creates a thumbnail image of the specific size. This image will be later assigned to an item that supports the asynchronous image load feature.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.1.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

public Image CreateThumbnailImage(
    Image image,
    Size size
)

VB.NET

Public Function CreateThumbnailImage(
    image As Image,
    size As Size
) As Image

Parameters

Name	Type	Description
image	Image	An Image that will be transformed to the thumbnail image.
size	Size	A Size structure that is the size of the thumbnail image.

Returns

Type	Description
Image	An Image created by this method.

Remarks

The CreateThumbnailImage method takes an image as its first argument and scales it to the specific size. This size is stored within the ThumbnailImageEventArgs.DesiredThumbnailSize property or can be passed directly to the CreateThumbnailImage method overload as the second parameter. The resulting image is called a thumbnail, and is later assigned using the ThumbnailImageEventArgs.ThumbnailImage property to an element that fired the GetThumbnailImage event. See the BaseGallery.GetThumbnailImage and WinExplorerView.GetThumbnailImage events to learn more.