ListView::ListViewItemCollection::IndexOfKey Method (String^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves the index of the 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 find in the collection.

Return Value

Type: System::Int32

The zero-based index of the first occurrence of the item with the specified key, if found; otherwise, -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.

The Name property corresponds to the key for a ListViewItem in the ListView::ListViewItemCollection.

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

.NET Framework
Available since 2.0
Return to top
Show: