Control.ControlCollection.IndexOfKey(String) Method

Definition

Retrieves the index of the first occurrence of the specified item within the collection.

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 control to search for.

Returns

The zero-based index of the first occurrence of the control with the specified name in the collection.

Remarks

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 key comparison is not case-sensitive. If the key parameter is null or an empty string, or an item with the specified key is not found, IndexOfKey returns -1.

The Name property of a Control corresponds to the key for a Control in the Control.ControlCollection.

Applies to