ListView.CheckedListViewItemCollection.IndexOfKey(String) Method

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Determines the index for an item with the specified key.

public:
 virtual int IndexOfKey(System::String ^ key);

public virtual int IndexOfKey (string key);

abstract member IndexOfKey : string -> int
override this.IndexOfKey : string -> int

Public Overridable Function IndexOfKey (key As String) As Integer

Parameters

key: String

The name of the item to retrieve the index for.

Returns

Int32

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

Exceptions

InvalidOperationException

The owner ListView is in virtual mode.

Remarks

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.