IImageList.SetOverlay

Syntax

SetOverlay(Image: Integer; Overlay: Integer): Boolean;

Parameters

Image. Index of the image, which will be used as an overlay. Available value of the parameter is within the range [0; Count).

Overlay. Index of the overlay that is assigned to the image. This index is further specified as the value of the IListViewItem.OverlayIndex or ITreeListNode.OverlayIndex properties. The allowed value of the parameter is in the range [0; 14].

Description

The SetOverlay method identifies image in the list as the image that can be used as an overlay.

Comments

Overlay is an image that is placed above the icon of the component element.

The method returns True if the image is identified successfully.

The method returns False if the value of any parameter exceeds the limits of the allowed range.

Example

The method use is given in descriptions of the IListViewItem.OverlayIndex and ITreeListNode.OverlayIndex properties.