Export (0) Print
Expand All

ListViewItem.StateImageIndex Property

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 int StateImageIndex { get; set; }

Property Value

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

ExceptionCondition
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.

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft