Export (0) Print
Expand All

Control.ControlCollection Class

Represents a collection of Control objects

For a list of all members of this type, see Control.ControlCollection Members.

System.Object
   System.Windows.Forms.Control.ControlCollection
      System.Windows.Forms.Form.ControlCollection
      System.Windows.Forms.TabControl.ControlCollection
      System.Windows.Forms.TabPage.TabPageControlCollection

[Visual Basic]
Public Class Control.ControlCollection
   Implements IList, ICollection, IEnumerable, ICloneable
[C#]
public class Control.ControlCollection : IList, ICollection,
   IEnumerable, ICloneable
[C++]
public __gc class Control.ControlCollection : public IList,
   ICollection, IEnumerable, ICloneable
[JScript]
public class Control.ControlCollection implements IList,
   ICollection, IEnumerable, ICloneable

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

The Add, Remove, and RemoveAt methods enable you to add and remove individual controls from the collection. You can also use the AddRange or Clear methods to add or remove all the controls from the collection.

You can determine if a Control is a member of the collection by passing the control into the Contains method. To get the index value of the location of a Control in the collection, pass the control into the IndexOf method. The collection can be copied into an array by calling the CopyTo method.

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

Namespace: System.Windows.Forms

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

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

See Also

Control.ControlCollection Members | System.Windows.Forms Namespace | Control | IList

Show:
© 2014 Microsoft