ListView.CheckedListViewItemCollection.IndexOfKey(String) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to