[Overview][Types][Classes][Procedures and functions][Index] | Reference for unit 'ImgList' (#lcl)

# TCustomImageListResolution

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements an image resolution (or size) used in TCustomImageList.

## Declaration

Source position: imglist.pp line 114

`type TCustomImageListResolution = class(TLCLReferenceComponent)`
`protected`
`function GetReferenceHandle; override;` |  | Gets the handle from the widgetset Reference for the image list.
`function WSCreateReference(); override;` |  | Creates the Reference image list using the facilities for the widgetset.
`class procedure WSRegisterClass; override;` |  | Registers the class type used to create references for the widgetset.
`procedure ReferenceDestroying; override;` |  | Notifies an image list list when the handle for the resolution is freed.
`public`
`destructor Destroy; override;` |  | Destructor for the class instance.
`function GetHotSpot; virtual;` |  | Get the coordinates for the HotSpot in an image in the list.
`procedure FillDescription();` |  | Stores the image description for the raw image data for the resolution.
`procedure GetBitmap();` |  | Gets the bitmap for an image drawn using the specified drawing effect.
`procedure GetIcon();` |  | Gets an Icon rendered using the specified drawing effect.
`procedure GetFullBitmap();` |  | Gets a bitmap representing all images in the resolution.
`procedure GetRawImage();` |  | Gets the 32-bit RGBA raw image data for the specified image.
`procedure Draw();` |  | Renders an image to the specified canvas.
`procedure StretchDraw();` |  | Draws an image stretched to the dimensions for the target rectangle.
`procedure DrawOverlay();` |  | Draws the specified image with the given overlay.
`property ImageList: TCustomImageList; [r]` |  | Image list which owns the resolution.
`property Width: Integer; [r]` |  | Width of the images stored in the resolution.
`property Height: Integer; [r]` |  | Height of the images stored in the resolution.
`property Count: Integer; [r]` |  | Number of images stored in the resolution.
`property AutoCreatedInDesignTime: Boolean; [rw]` |  | Indicates if the Resolution was auto-created at design-time.
`property Reference: TWSCustomImageListReference; [r]` |  | Reference to the widgetset image list using this resolution.
`end;`

## Inheritance

`TCustomImageListResolution` |  | Implements an image resolution (or size) used in TCustomImageList.
`TLCLReferenceComponent` |  | Base class for all components having an associated widget with a handle.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TCustomImageListResolution is a TLCLReferenceComponent descendant that implements an image resolution (or size) used in TCustomImageList. TCustomImageListResolution (along with TCustomImageListResolutions) is the mechanism which makes multiple resolutions possible in TCustomImageList.

TCustomImageListResolution provides properties that indicate the Height and Width of images stored in the resolution. It also contains the 32-bit RGBA raw image data for its images, the handle for its image list, and whether the resolution was created at design-time. Methods are provided to access and maintain the bitmap images (or their masks) used in the resolution. Other methods can be used to get the images as bitmaps, icons, or raw image data.

TCustomImageListResolution instances are created and stored in a TCustomImageListResolutions container. TCustomImageListResolution is the type used for the Resolution and ResolutionByIndex properties in TCustomImageList.

## See also

TCustomImageListResolutions |  | Provides multiple image resolutions in TCustomImageList.
TCustomImageList.Resolution |  | Provides indexed access to an image resolution with the specified image width.
TCustomImageList.ResolutionByIndex |  | Provides access to an image resolution by its ordinal position in the image list.