ImageIndex Property

ListViewItem::ImageIndex Property

 

Gets or sets the index of the image that is displayed for the item.

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

public:
property int ImageIndex {
	int get();
	void set(int value);
}

Property Value

Type: System::Int32

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

Exception Condition
ArgumentException

The value specified is less than -1.

The value of this property depends on the value of the ImageList property. Depending on the current value of the View property of the ListView control associated with the item, the ImageList used by the item could be one specified in the LargeImageList property or the SmallImageList property of the ListView control. If the View property is set to LargeIcon, the ImageList specified in the LargeImageList property is used; otherwise, the ImageList specified in the SmallImageList property is used. The images defined in the ImageList specified in the SmallImageList should have the same index positions as the images in the ImageList specified in the LargeImageList property. If the index positions are the same for both ImageList controls, you can set a single index value for the ImageIndex property and the appropriate image will be displayed regardless of the value of the View property of the ListView control. The ImageKey and ImageIndex properties are mutually exclusive, meaning if one is set, the other is ignored. Furthermore, if you set the ImageKey property, the ImageIndex property is automatically set to -1. Alternatively, if you set the ImageIndex property, the ImageKey is automatically set to an empty string ("").

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft