This documentation is archived and is not being maintained.

ListViewItem.ImageKey Property

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)

[LocalizableAttribute(true)] 
[TypeConverterAttribute(typeof(ImageKeyConverter))] 
public string ImageKey { get; set; }
/** @property */
public String get_ImageKey ()

/** @property */
public void set_ImageKey (String value)

public function get ImageKey () : String

public function set ImageKey (value : String)

Not applicable.

Property Value

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 ("").

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.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: