ControlCollection.Add(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.

public:
 virtual void Add(System::Web::UI::Control ^ child);

public virtual void Add (System.Web.UI.Control child);

abstract member Add : System.Web.UI.Control -> unit
override this.Add : System.Web.UI.Control -> unit

Public Overridable Sub Add (child As Control)

Parameters

child: Control

The Control to add to the collection.

Exceptions

ArgumentNullException

The child parameter does not specify a control.

HttpException

The ControlCollection is read-only.

Examples

The following code example uses the Add method to add a series of template items, the number of which are taken from the server control's view state, to a custom templated control.

// Override to create repeated items.
protected override void CreateChildControls() {
    object o = ViewState["NumItems"];
    if (o != null) {
       // Clear any existing child controls.
       Controls.Clear();

       int numItems = (int)o;
       for (int i=0; i < numItems; i++) {
          // Create an item.
          RepeaterItem item = new RepeaterItem(i, null);
          // Initialize the item from the template.
          ItemTemplate.InstantiateIn(item);
          // Add the item to the ControlCollection.
          Controls.Add(item);
       }
    }
}

' Override to create repeated items.
Protected Overrides Sub CreateChildControls()
    Dim O As Object = ViewState("NumItems")
    If Not (O Is Nothing)
       ' Clear any existing child controls.
       Controls.Clear()

       Dim I As Integer
       Dim NumItems As Integer = CInt(O)
       For I = 0 To NumItems - 1
          ' Create an item.
          Dim Item As RepeaterItemVB = New RepeaterItemVB(I, Nothing)
          ' Initialize the item from the template.
          ItemTemplate.InstantiateIn(Item)
          ' Add the item to the ControlCollection.
          Controls.Add(Item)
       Next
    End If
End Sub

Remarks

The new control is added to the end of an ordinal index array. The control can be an instance of any ASP.NET server control, a custom server control you create, or a literal control.

To add a control to the collection at a specific index location, use the AddAt method.

Applies to

Sdílet prostřednictvím