ControlCollection.Remove Method (System.Web.UI)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

ControlCollection.Remove Method

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

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

Syntax

Visual Basic

Public Overridable Sub Remove ( _
	value As Control _
)

public virtual void Remove(
	Control value
)

Visual C++

public:
virtual void Remove(
	Control^ value
)

abstract Remove : 
        value:Control -> unit 
override Remove : 
        value:Control -> unit

Parameters

value: Type: System.Web.UI.Control
The server control to be removed.

Remarks

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

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.

Visual Basic


' 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


// 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." ;

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

ControlCollection Class

System.Web.UI Namespace

RemoveAt

Controls