Control.ControlCollection.GetChildIndex Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the index of a control within the control collection.
| 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. |
- Source:
- Control.ControlCollection.cs
- Source:
- Control.ControlCollection.cs
- Source:
- Control.ControlCollection.cs
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 -> intPublic Function GetChildIndex (child As Control) As IntegerParameters
Returns
A zero-based index value that represents the location of the specified child control within the control collection.
Exceptions
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
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9, 10 |
- Source:
- Control.ControlCollection.cs
- Source:
- Control.ControlCollection.cs
- Source:
- Control.ControlCollection.cs
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 -> intabstract member GetChildIndex : System.Windows.Forms.Control * bool -> int
override this.GetChildIndex : System.Windows.Forms.Control * bool -> intPublic Function GetChildIndex (child As Control, throwException As Boolean) As IntegerPublic Overridable Function GetChildIndex (child As Control, throwException As Boolean) As IntegerParameters
- 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
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
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
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9, 10 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: