Export (0) Print
Expand All

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
)
public int GetChildIndex (
	Control child, 
	boolean throwException
)
public function GetChildIndex (
	child : Control, 
	throwException : boolean
) : int

Parameters

child

The Control to search for in the control collection.

throwException

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

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.

Exception typeCondition

ArgumentException

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

Community Additions

ADD
Show:
© 2015 Microsoft