Back to Devexpress

TcxCustomImageList Class

vcl-cximagelist-35a51a88.md

latest8.4 KB
Original Source

TcxCustomImageList Class

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

Declaration

delphi
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. These members allow you to add, rearrange, save, delete, and access images.

Image Management

Add | AddBitmap | AddIcon | AddImage | AddImageFromResource | AddMasked | FileLoad | GetInstRes | GetResource | LoadImage | ResInstLoad | ResourceLoadAdd an image to the end of the list from the specified source.AddImages | AddImagesFromResZipStream | AddImagesFromZipStream | CopyImages | LoadFromResourceAdd multiple images to the end of the list from the specified source.ClearClears the image list.DeleteAllows you to delete individual images.Insert | InsertIcon | InsertMaskedInsert an image to any position in the list from the specified source.MoveMoves the specified image to a new position within the list.Replace | ReplaceIcon | ReplaceMaskedReplace specific stored images from the specified source.

Stored Image Properties

ColorDepthSpecifies the pixel format for images.CompressDataAllows you to compress images.GetImage | GetImageInfo | GetMaskReturn image and transparency mask bitmaps that correspond to stored images.GetKeywords | GetSourceFileNameReturn optional keywords and source file paths for individual images.ResizeSpecify the dimensions of stored images.SourceDPISpecifies the target DPI for images.SupportsPaletteAllows you to identify if individual images support palettes. Only vector images support palettes.Width | Height | SetSize | ResizeSpecify the dimensions of stored images.

Skin Palette-Related Settings

UseDisabledSkinPaletteForSVG | UseEnabledSkinPaletteForSVGSpecify if the active vector skin palette affects stored SVG glyphs.

Image Draw APIs

AlphaBlendingAllows you to ignore alpha channel information for image draw operations.Draw | DrawOverlayDraw stored images on the target canvas.

General-Purpose API Members

BeginUpdate | EndUpdate | CancelUpdateAllow you to avoid excessive listener updates to improve performance.ChangeSends content change notifications to image list listeners and raises the OnChange event.GetPixelFormatReturns the pixel format of the image list by its handle.HandleSpecifies the image list handle. The list deletes all stored images if you assign a new handle to this property.IsEqualsCompares the current image list with another image list.LoadFromFile | LoadFromStream | SaveToFile | SaveToStreamAllow you to store the image list state in a file or stream.

Terminal TcxCustomImageList Class Descendant

Do not use the TcxCustomImageList class directly. Use the TcxImageList component instead.

Inheritance

TObject TPersistent TComponent TBaseImageList TCustomImageList TDragImageList TcxBaseImageList TcxCustomImageList

See Also

TdxSmartImage Class

TdxSmartGlyph Class

TcxCustomImageList Members

cxImageList Unit