ListView.ColumnHeaderCollection.IndexOfKey(String) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Determines the index for a column 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 column to retrieve the index for.

Returns

Int32

The zero-based index for the first occurrence of the column with the specified name, if found; otherwise, -1.

Remarks

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

The Name property corresponds to the key for a column in the ListView.ColumnHeaderCollection.

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.