Export (0) Print
Expand All

Control.ControlCollection.Add Method

Adds the specified control to the control collection.

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

'Declaration
Public Overridable Sub Add ( _
	value As Control _
)

Parameters

value
Type: System.Windows.Forms.Control

The Control to add to the control collection.

ExceptionCondition
Exception

The specified control is a top-level control, or a circular control reference would result if this control were added to the control collection.

ArgumentException

The object assigned to the value parameter is not a Control.

The Add method allows you to add Control objects to the end of the control collection.

You can also add new Control objects to the collection by using the AddRange method.

To remove a Control that you previously added, use the Remove, RemoveAt, or Clear methods.

NoteNote

A Control can only be assigned to one Control.ControlCollection at a time. If the Control is already a child of another control it is removed from that control before it is added to another control.

Notes to Inheritors

When overriding Add in a derived class, be sure to call the base class's Add method to ensure that the control is added to the collection.

The following code example adds a Control to the Control.ControlCollection of the derived class Panel. The example requires that you have created a Panel control and a Button control on a Form. When the button is clicked, a TextBox control is added to the panel's Control.ControlCollection.

    ' Create a TextBox to add to the Panel. 
    Dim TextBox1 As TextBox = New TextBox()

    ' Add controls to the Panel using the Add method. 
    Private Sub AddButton_Click(ByVal sender As System.Object, _
		ByVal e As System.EventArgs) Handles AddButton.Click
        Panel1.Controls.Add(TextBox1)
    End Sub

.NET Framework

Supported in: 4.6, 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