Export (0) Print
Expand All

ControlCollection.AddAt Method

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

[Visual Basic]
Public Overridable Sub AddAt( _
   ByVal index As Integer, _
   ByVal child As Control _
)
[C#]
public virtual void AddAt(
 int index,
 Control child
);
[C++]
public: virtual void AddAt(
 int index,
 Control* child
);
[JScript]
public function AddAt(
   index : int,
 child : Control
);

Parameters

index
The location in the array to add the child control.
child
The Control object to add to the collection.

Exceptions

Exception Type 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 object 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.

Example

[Visual Basic] The following example uses the AddAt method to create a new LiteralControl named ChildControl2 and add it to the myButton control's ControlCollection 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))

[C#, C++, JScript] No example is available for C#, C++, or JScript. To view a Visual Basic example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

ControlCollection Class | ControlCollection Members | System.Web.UI Namespace | Controls | Add

Show:
© 2015 Microsoft