GetChildIndex Method (Control, Boolean)
Collapse the table of content
Expand the table of content

Control.ControlCollection.GetChildIndex Method (Control, Boolean)

Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual int GetChildIndex(
	Control child,
	bool throwException


Type: System.Windows.Forms.Control

The Control to search for in the control collection.

Type: System.Boolean

true to throw an exception if the Control specified in the child parameter is not a control in the Control.ControlCollection; otherwise, false.

Return Value

Type: System.Int32
A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified Control is not found in the Control.ControlCollection.


The child Control is not in the Control.ControlCollection, and the throwException parameter value is true.

The control with an index value of zero is at the top of the z-order, and higher numbers are closer to the bottom. A return value of -1 is returned only when the throwException parameter is false.

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, 1.1, 1.0

Community Additions

© 2015 Microsoft