Controls Property

Control.Controls Property


Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

public virtual ControlCollection Controls { get; }

Property Value

Type: System.Web.UI.ControlCollection

The collection of child controls for the specified server control.

On an ASP.NET page, when controls are added declaratively between the opening and closing tags of a server control, ASP.NET automatically adds the controls to the containing server control's ControlCollection. Any HTML tags or text strings that are not processed on the server are treated as LiteralControl objects. These are added to the collection like other server controls.

The Controls property allows you programmatic access to the instance of the ControlCollection class for any server control. You can add controls to the collection, remove controls from the collection, or iterate through the server controls in the collection.

Notes to Inheritors:

When overriding the Controls property, be sure to call the EnsureChildControls method. Furthermore, if you are planning to add controls to the controls collection programmatically, consider adding the controls in an overridden CreateChildControls method.

The following example demonstrates how to add child controls to a server control's ControlCollection object through its Controls property.

Controls.Add(new LiteralControl("<h3>Value: "));

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft