Sign in Join
FPDoc Onlineexperiment

TCustomImageList.Overlays property

Member of TCustomImageListpublicIn unit ImgList

Provides access to images used as overlays in the image list.

Declaration

pascal
property Overlays: TOverlayArray read FOverlays;

Description

Overlays is a read-only TOverlayArray property which provides access to images used as overlays in the image list. An overlay image is a mask drawn transparently over another image to represent its state or enhanced drawing style. Each element in the array is an Integer value with the ordinal position for an image in the list used as an overlay. Up to 15 of the images in the list can be used as an overlay image.

Values in Overlays are stored when the Overlay method is called to designate a specified image index for use in the overlay position. The ClearOverlays method causes each of the elements in Overlays to be set to -1 to indicate that an image index has not been assigned for the overlay position. Use HasOverlays to determine whether any images in the list have been designated as an overlay image.

A value in Overlays is passed as an argument to the DrawOverlay method for the image list resolution. Controls which utilize the Overlays feature include TTreeView and TLvlGraphControl (but not TListView).

Added in LCL version 5.0.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.