ControlCollection.AddAt(Int32, Control) Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

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.

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

public:
 virtual void AddAt(int index, System::Web::UI::Control ^ child);

public virtual void AddAt (int index, System.Web.UI.Control child);

abstract member AddAt : int * System.Web.UI.Control -> unit
override this.AddAt : int * System.Web.UI.Control -> unit

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

Parameters

index: Int32

The location in the array at which to add the child control.

child: Control

The Control to add to the collection.

Exceptions

ArgumentNullException

The child parameter does not specify a control.

ArgumentOutOfRangeException

The index parameter is less than zero or greater than the Count property.

HttpException

The ControlCollection is read-only.

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.

// 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));

' 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))

Remarks

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

Applies to

Share via