ListView.CheckedListViewItemCollection.IndexOfKey Method (String)

 

Determines the index for an item with the specified key.

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

public virtual int IndexOfKey(
	string key
)

Parameters

key
Type: System.String

The name of the item to retrieve the index for.

Return Value

Type: System.Int32

The zero-based index for the ListViewItem with the specified name, if found; otherwise, -1.

Exception Condition
InvalidOperationException

The owner ListView is in virtual mode.

The Name property of a ListViewItem corresponds to the key for an item in a ListView.CheckedListViewItemCollection.

The key comparison is not case-sensitive. If the key parameter is null or an empty string, IndexOfKey returns -1.

If IndexOfKey is called successively, the last returned index will be checked for a key match first, and if there is no match, the search starts at the beginning of the collection.

.NET Framework
Available since 2.0
Return to top
Show: