This documentation is archived and is not being maintained.

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

public virtual int IndexOfKey (
	string key
public int IndexOfKey (
	String key
public function IndexOfKey (
	key : String
) : int
Not applicable.



The name of the control to search for.

Return Value

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 a null reference (Nothing in Visual Basic) 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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0