IndexOfKey Method

Control.ControlCollection.IndexOfKey Method

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

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

Return Value

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

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2016 Microsoft