Export (0) Print
Expand All

Control.ControlCollection.Remove Method

Removes the specified control from the control collection.

[Visual Basic]
Public Overridable Sub Remove( _
   ByVal value As Control _
)
[C#]
public virtual void Remove(
 Control value
);
[C++]
public: virtual void Remove(
 Control* value
);
[JScript]
public function Remove(
   value : Control
);

Parameters

value
The Control to remove from the Control.ControlCollection.

Remarks

When a Control is removed from the control collection, all subsequent controls are moved up one position in the collection.

You can also remove a Control by using the RemoveAt or Clear methods.

To add new Control objects to the collection, use the Add or AddRange methods.

Notes to Inheritors:  When overriding Remove in a derived class, be sure to call the base class's Remove method to ensure that the control is removed from the collection.

Example

[Visual Basic, C#, C++] The following example removes a Control from the Control.ControlCollection of the derived class Panel if it is a member of the collection. The example assumes you have created a Panel, a Button, and at least one RadioButton control on a Form. The RadioButton control(s) are added to the Panel control, and the Panel control added to the Form. When the button is clicked, the radio button named radioButton2 is removed from the Control.ControlCollection.

[Visual Basic] 
' Remove the RadioButton control if it exists.
Private Sub RemoveButton_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles RemoveButton.Click
    If Panel1.Controls.Contains(RadioAddRangeButton) Then
        Panel1.Controls.Remove(RadioAddRangeButton)
    End If
End Sub

[C#] 
// Remove the RadioButton control if it exists.
private void removeButton_Click(object sender, System.EventArgs e)
{
   if(panel1.Controls.Contains(removeButton))
   {
      panel1.Controls.Remove(removeButton);
   }
}

[C++] 
// Remove the RadioButton control if it exists.
private:
void removeButton_Click(Object* /*sender*/, System::EventArgs* /*e*/) {
    if (panel1->Controls->Contains(removeButton)) {
        panel1->Controls->Remove(removeButton);
    }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

Control.ControlCollection Class | Control.ControlCollection Members | System.Windows.Forms Namespace | RemoveAt | Clear | Add

Show:
© 2015 Microsoft