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)

public virtual void 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 Note:

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 void clearButton_Click(object sender, System.EventArgs e)
{
   panel1.Controls.Clear();
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft