Control.ControlCollection.SetChildIndex Method (System.Windows.Forms)

SetChildIndex Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Control..::.ControlCollection..::.SetChildIndex Method

Sets the index of the specified child control in the collection to the specified index value.

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

Syntax

Visual Basic (Declaration)

Public Overridable Sub SetChildIndex ( _
    child As Control, _
    newIndex As Integer _
)

Visual Basic (Usage)

Dim instance As Control..::.ControlCollection
Dim child As Control
Dim newIndex As Integer

instance.SetChildIndex(child, newIndex)

public virtual void SetChildIndex(
    Control child,
    int newIndex
)

Visual C++

public:
virtual void SetChildIndex(
    Control^ child, 
    int newIndex
)

JScript

public function SetChildIndex(
    child : Control, 
    newIndex : int
)

Parameters

child: Type: System.Windows.Forms..::.Control
The child Control to search for.

newIndex: Type: System..::.Int32
The new index value of the control.

Exceptions

Exception	Condition
ArgumentException	The child control is not in the Control..::.ControlCollection.

Remarks

When SetChildIndex is called, the Control referred to by the child parameter is moved to the position specified by newIndex and the other Control references in the Control..::.ControlCollection are reordered to accommodate the move. The control with an index value of zero is at the top of the z-order, and higher numbers are closer to the bottom.

Platforms

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

Control..::.ControlCollection Class

Control..::.ControlCollection Members

System.Windows.Forms Namespace

GetChildIndex