Control.ControlCollection.IndexOfKey(String) Method

Definition

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

public virtual int IndexOfKey (string key);
public virtual int IndexOfKey (string? key);

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

产品 版本
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9