ControlCollection.AddAt Method (System.Web.UI)

AddAt Method

.NET Framework Class Library

ControlCollection..::.AddAt Method

Adds the specified Control object to the collection at the specified index location.

Namespace: System.Web.UI
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Overridable Sub AddAt ( _
    index As Integer, _
    child As Control _
)

Visual Basic (Usage)

Dim instance As ControlCollection
Dim index As Integer
Dim child As Control

instance.AddAt(index, child)

public virtual void AddAt(
    int index,
    Control child
)

Visual C++

public:
virtual void AddAt(
    int index, 
    Control^ child
)

JScript

public function AddAt(
    index : int, 
    child : Control
)

Parameters

index: Type: System..::.Int32
The location in the array at which to add the child control.

child: Type: System.Web.UI..::.Control
The Control to add to the collection.

Exceptions

Exception	Condition
ArgumentNullException	The child parameter does not specify a control.
ArgumentOutOfRangeException	The index parameter is less than zero or greater than the ControlCollection..::.Count property.
HttpException	The ControlCollection is read-only.

Remarks

The added control can be an instance of any ASP.NET server control, a custom server control you create, or a literal control.

Examples

The following code example uses the AddAt method to create a new LiteralControl named ChildControl2 and add it to the myButton control's ControlCollection collection at the index location of 1.

Visual Basic

' Create a LiteralControl and use the Add method to add it
' to a button's ControlCollection, then use the AddAt method
' to add another LiteralControl to the collection at the
' index location of 1.
Dim myLiteralControl As LiteralControl =  _
    new LiteralControl("ChildControl1")
myButton.Controls.Add(myLiteralControl)
myButton.Controls.AddAt(1,new LiteralControl("ChildControl2"))
Response.Write("<b>ChildControl2 is added at index 1</b>")

' Get the Index location of the myLiteralControl LiteralControl
' and write it to the page.
Response.Write("<br /><b>Index of the ChildControl myLiteralControl is </b>" & _
                 myButton.Controls.IndexOf(myLiteralControl))

// Create a LiteralControl and use the Add method to add it
// to a button's ControlCollection, then use the AddAt method
// to add another LiteralControl to the collection at the
// index location of 1.
LiteralControl myLiteralControl = new LiteralControl("ChildControl1");
myButton.Controls.Add(myLiteralControl);
myButton.Controls.AddAt(1,new LiteralControl("ChildControl2"));
Response.Write("<b>ChildControl2 is added at index 1</b>");

// Get the Index location of the myLiteralControl LiteralControl
// and write it to the page.
Response.Write("<br /><b>Index of the ChildControl myLiteralControl is " +
    "</b>" + myButton.Controls.IndexOf(myLiteralControl));

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

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

Reference

ControlCollection Class

ControlCollection Members

System.Web.UI Namespace

Controls

Add