Description
Each item in a tree-view control can have up to four images associated with it.
- An image, such as an open folder, displayed when the item is selected.
- An image, such as a closed folder, displayed when the item is not selected.
- An overlay image that is drawn transparently over the selected or non-selected image.
- A state image: an additional image displayed to the left of the selected or non-selected image. You can use state images, such as checked and cleared check boxes, to indicate application-defined item states.
Use this property to get the index of the state image. To get the Picture object that contains a state image read the StateImage property.
To obtain the image for a non-selected item, selected item or index of the overlay image, use the Image, SelectedImage and OverlayImageIndex properties respectively.
Declaration
TestObj.StateImageIndex
| Read-Only Property | Integer |
| TestObj | A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section | |||
Applies To
The property is applied to the following object:
View Mode
To view this property in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.
Property Value
A zero-based integer value that means the image’s position within the image list.
Example
To view an example that demonstrates how to use the StateImageIndex property, see Getting Tree View Item's Images.
See Also
Picture Object
Image Property (TreeViewItem Objects)
OverlayImageIndex Property (TreeViewItem Objects)
SelectedImage Property (TreeViewItem Objects)
StateImage Property (TreeViewItem Objects)