Control.ControlCollection.IndexOfKey Method

Note: This method is new in the .NET Framework version 2.0.

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



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.

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 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions