ListViewItem.StateImageIndex Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the index of the state image (an image such as a selected or cleared check box that indicates the state of the item) that is displayed for the item.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

<RelatedImageListAttribute("ListView.StateImageList")>
Public Property StateImageIndex As Integer

Property Value

Type: System.Int32

The zero-based index of the state image in the ImageList that is displayed for the item.

Exception Condition
ArgumentOutOfRangeException

The value specified for this property is less than -1.

-or-

The value specified for this property is greater than 14.

This property allows you to specify the index into the ImageList assigned to the StateImageList property of the associated ListView control, where the state images to display to the left of the item are stored. Typically, the state image is a selected or cleared check box or an image that is intended to represent selected or cleared states for the item. If no value is specified for the StateImageList property, the ListView control displays a default selected or cleared check box when the CheckBoxes property of the control is set to true.

System_CAPS_noteNote

Although the ImageList specified in the StateImageList property can contain any number of images, and the StateImageIndex property can be set to any value equal to or lower than 14, only the images at index positions 0 and 1 are displayed as state images.

.NET Framework
Available since 1.1
Return to top
Show: