Clear Method

ControlCollection.Clear Method ()


Removes all controls from the current server control's ControlCollection object.

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

public virtual void Clear()

Use this method to empty a custom control's ControlCollection when you override the Control.CreateChildControls and DataBind methods. Do this when you develop composite, templated controls or templated data-bound controls.

The following code example demonstrates overriding the Control.CreateChildControls method, and using the Clear method to delete all child controls previously in the ControlCollection object. In this case, you must do this so that outdated objects in your control's ControlCollection are not displayed inappropriately.

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

       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.
          // Add the item to the ControlCollection.

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft