Edit

Share via

Control.ControlCollection.Remove(Control) Method

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Removes the specified control from the control collection.

public:
 virtual void Remove(System::Windows::Forms::Control ^ value);
public virtual void Remove (System.Windows.Forms.Control value);
public virtual void Remove (System.Windows.Forms.Control? value);
abstract member Remove : System.Windows.Forms.Control -> unit
override this.Remove : System.Windows.Forms.Control -> unit
Public Overridable Sub Remove (value As Control)

Parameters

value
Control

The Control to remove from the Control.ControlCollection.

Examples

The following code example removes a Control from the Control.ControlCollection of the derived class Panel if it is a member of the collection. The example requires that you have created a Panel, a Button, and one or more RadioButton controls on a Form. The RadioButton controls are added to the Panel control, and the Panel control is added to the Form. When the button is clicked, the radio button named radioButton2 is removed from the Control.ControlCollection.

   // 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 );
      }
   }

// 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);
   }
}

' 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(RemoveButton) Then
        Panel1.Controls.Remove(RemoveButton)
    End If
End Sub

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 method, or remove all controls by using the Clear method.

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

Notes to Inheritors

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

Applies to

See also