Export (0) Print
Expand All

Control.ControlCollection.Clear Method

Removes all controls from the collection.

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

'Declaration
Public Overridable Sub Clear

Implements

IList.Clear

You can use the Clear method to remove the entire collection of controls from a parent control.

To remove an individual control from the collection, use the Remove or RemoveAt methods.

Important noteImportant

Calling the Clear method does not remove control handles from memory. You must explicitly call the Dispose method to avoid memory leaks.

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

Notes to Inheritors

When overriding Clear in a derived class, be sure to call the base class's Clear method to ensure that all the controls are removed from the collection.

The following code example removes all the Control objects in the Control.ControlCollection of the derived class Panel. The example requires that you have created a Panel, a Button, and at least one other control on a Form. The other controls are added to the Panel control, and the Panel added to the Form. When the button is clicked, all the controls contained in the panel are removed from the Control.ControlCollection.

    ' Clear all the controls in the Panel. 
    Private Sub ClearButton_Click(ByVal sender As System.Object, _
		ByVal e As System.EventArgs) Handles ClearButton.Click
        Panel1.Controls.Clear()
    End Sub

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft