IImageList.SetOverlay

Syntax

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

Parameters

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

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

Description

The SetOverlay method identifies image in the list as the image that can be used as covering mask.

Comments

Covering mask is a picture that is placed above the icon of the component element.

The method returns True, if the identification was done successfully.

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

Example

An example of method use is given in descriptions of the IListViewItem.OverlayIndex and ITreeListNode.OverlayIndex methods.