Back to Devexpress

TcxImageList Class

vcl-cxgraphics.md

latest9.4 KB
Original Source

TcxImageList Class

An advanced DevExpress image list component.

Declaration

delphi
TcxImageList = class(
    TcxCustomImageList
)

Remarks

An image list is a non-visual component designed to store and manage a collection of images of the same size that you can access by index. Many DevExpress controls use image lists as sources of UI glyphs. The TcxImageList component is derived from the standard TImageList component.

Design-Time Functionality

The TcxImageList component ships with the design-time Image List Editor dialog. You can use it to import, manage, export, and browse images.

You can import images from any other image list on the same form at design time. Right-click an image list and click the Assign From menu item, and select the required source image list (a TImageList class descendant instance).

Main API Members

The list below outlines key members of the TcxImageList 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.DeleteDeletes 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.

Inheritance

TObject TPersistent TComponent TBaseImageList TCustomImageList TDragImageList TcxBaseImageList TcxCustomImageList TcxImageList

See Also

TcxImageCollection Class

Image Picker

Icon Library

Image List Editor

TcxImageList Members

cxGraphics Unit