Export (0) Print
Expand All

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 nullptr 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.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft