Edit

Share via

Control.ControlCollection.GetChildIndex Method

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Retrieves the index of a control within the control collection.

Overloads

GetChildIndex(Control)

Retrieves the index of the specified child control within the control collection.
GetChildIndex(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.

GetChildIndex(Control)

Retrieves the index of the specified child control within the control collection.

public:
 int GetChildIndex(System::Windows::Forms::Control ^ child);
public int GetChildIndex (System.Windows.Forms.Control child);
member this.GetChildIndex : System.Windows.Forms.Control -> int
Public Function GetChildIndex (child As Control) As Integer

Parameters

child
Control

The Control to search for in the control collection.

Returns

Int32

A zero-based index value that represents the location of the specified child control within the control collection.

Exceptions

ArgumentException

The child control is not in the Control.ControlCollection.

Remarks

The control with an index value of zero is at the top of the z-order, and higher numbers are closer to the bottom.

See also

Applies to

GetChildIndex(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.

public:
 int GetChildIndex(System::Windows::Forms::Control ^ child, bool throwException);
public:
 virtual int GetChildIndex(System::Windows::Forms::Control ^ child, bool throwException);
public int GetChildIndex (System.Windows.Forms.Control child, bool throwException);
public virtual int GetChildIndex (System.Windows.Forms.Control child, bool throwException);
member this.GetChildIndex : System.Windows.Forms.Control * bool -> int
abstract member GetChildIndex : System.Windows.Forms.Control * bool -> int
override this.GetChildIndex : System.Windows.Forms.Control * bool -> int
Public Function GetChildIndex (child As Control, throwException As Boolean) As Integer
Public Overridable Function GetChildIndex (child As Control, throwException As Boolean) As Integer

Parameters

child
Control

The Control to search for in the control collection.

throwException
Boolean

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

Returns

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.

Exceptions

ArgumentException

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

Remarks

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.

See also

Applies to