IndexOfKey Method

ListView.CheckedListViewItemCollection.IndexOfKey Method

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.

ExceptionCondition
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

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2016 Microsoft