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

Removes the specified server control from the parent server control's ControlCollection object.

public:
 virtual void Remove(System::Web::UI::Control ^ value);

public virtual void Remove (System.Web.UI.Control value);

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

Public Overridable Sub Remove (value As Control)

Parameters

value: Control

The server control to be removed.

Examples

The following code example uses the Remove method to delete a child control from the myButton server control. First the code uses the Contains method to determine whether the myChildControl is contained in the ControlCollection object, and, if it is, removes it.

// Use the Contains method to check whether
// a child control exists, and if it does,
// use the Remove method to delete it.        
if (myButton.Controls.Contains(myChildControl))
{
   myButton.Controls.Remove(myChildControl);
   msgRemove.Text = "You removed myLiteralControl.";
}
else msgRemove.Text="The control to remove does not exist." ;

' Use the Contains method to check whether
' a child control exists, and if it does,
' use the Remove method to delete it.        
If myButton.Controls.Contains(myChildControl)
   myButton.Controls.Remove(myChildControl)
   msgRemove.Text = "You removed myLiteralControl."
Else
   msgRemove.Text="The control to remove does not exist." 
End If

Remarks

To remove a control from an index location, use the RemoveAt method.

Applies to

Deila með