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
)

Parameters

child
Type: System.Windows.Forms::Control^

The Control to search for in the control collection.

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

Exception Condition
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.

.NET Framework
Available since 1.1
Return to top
Show: