Control.ControlCollection.Remove Method (Control)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Removes the specified control from the control collection.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Overridable Sub Remove (
	value As Control
)

Parameters

value
Type: System.Windows.Forms.Control

The Control to remove from the Control.ControlCollection.

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 in a derived class, be sure to call the base class's Remove method to ensure that the control is removed from the collection.

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 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

.NET Framework
Available since 1.1
Return to top
Show: