ListViewItem::ImageKey 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 key for the image that is displayed for the item.

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

public:
[TypeConverterAttribute((ImageKeyConverter^::typeid))]
property String^ ImageKey {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

The key for the image that is displayed for the ListViewItem.

The ImageKey property returns an empty string ("") when the ImageKey is not set for the ListViewItem. The ImageKey and ImageIndex properties are mutually exclusive, meaning if one is set, the other is ignored. 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 ("").

System_CAPS_noteNote

If you are using multiple image lists, for small and large icon view, with a ListView control, you should place small and large versions of the image at the same index location in their respective image lists. When switching between views, the index location of the image in one list is used to locate the image in the other list, regardless of the key value specified.

.NET Framework
Available since 2.0
Return to top
Show: