TcxCustomImageList Class

The base class for a DPI-aware image list component.

Declaration

TcxCustomImageList = class(
    TcxBaseImageList
)

Remarks

An image list is a non-visual component that stores and manages a collection of same-sized images you can access by index. Many DevExpress controls use image lists as sources of UI glyphs.

Main API Members

The list below outlines key members of the TcxCustomImageList class that allow you to add, rearrange, save, delete, and access images.

Image Management

Add | AddBitmap | AddIcon | AddImage | AddImageFromResource | AddMasked | FileLoad | GetInstRes | GetResource | LoadImage | ResInstLoad | ResourceLoad: Add an image to the end of the list from the specified source.
Insert | InsertIcon | InsertMasked: Insert an image to any position in the list from the specified source.
AddImages | AddImagesFromResZipStream | AddImagesFromZipStream | CopyImages | LoadFromResource: Add multiple images to the end of the list from the specified source.
Replace | ReplaceIcon | ReplaceMasked: Replace specific stored images from the specified source.
Clear: Clears the image list.
Delete: Allows you to delete individual images.
Move: Moves the specified image to a new position within the list.

Stored Image Properties

ColorDepth: Specifies the pixel format for images.
CompressData: Allows you to compress images.
SourceDPI: Specifies the target DPI for images.
GetKeywords | GetSourceFileName: Return optional keywords and source file paths for individual images.
Width | Height | SetSize | Resize: Specify the dimensions of stored images.
GetImage | GetImageInfo | GetMask: Return image and transparency mask bitmaps that correspond to stored images.

Image Draw APIs

AlphaBlending: Allows you to ignore alpha channel information for image draw operations.
Draw | DrawOverlay: Draw stored images on the target canvas.

General-Purpose API Members

BeginUpdate | EndUpdate | CancelUpdate: Allow you to avoid excessive listener updates to improve performance.
Change: Sends content change notifications to image list listeners and raises the OnChange event.
Handle: Specifies the image list handle. The list deletes all stored images if you assign a new handle to this property.
LoadFromFile | LoadFromStream | SaveToFile | SaveToStream: Allow you to store the image list state in a file or stream.
IsEquals: Compares the current image list with another image list.
GetPixelFormat: Returns the pixel format of the image list by its handle.