Vcl.ComCtrls.TListItem.OverlayIndex

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OverlayIndex: TImageIndex index 1 read GetImage write SetImage;

C++

__property System::Uitypes::TImageIndex OverlayIndex = {read=GetImage, write=SetImage, index=1, nodefault};

Properties

Type Visibility Source Unit Parent
property public
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TListItem

Description

Determines which image from the image list is used as an overlay mask.

Use OverlayIndex to display an overlay mask on an item in the list when the ViewStyle of the list view is vsIcon or vsSmallIcon. OverlayIndex is the index of the overlay image in the StateImages property of the list view.

An overlay mask is an image drawn transparently over the icon for the item in the list view. For example, to indicate that an item is no longer available, an application could use an overlay image of an X over the item's image.

See Also