This topic has not yet been rated Rate this topic

ControlCollection Class

Provides a collection container that enables ASP.NET server controls to maintain a list of their child controls.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
public class ControlCollection : ICollection, 
	IEnumerable

The ControlCollection type exposes the following members.

  Name Description
Public method ControlCollection Initializes a new instance of the ControlCollection class for the specified parent server control.
Top
  Name Description
Public property Count Gets the number of server controls in the ControlCollection object for the specified ASP.NET server control.
Public property IsReadOnly Gets a value indicating whether the ControlCollection object is read-only.
Public property IsSynchronized Gets a value indicating whether the ControlCollection object is synchronized.
Public property Item Gets a reference to the server control at the specified index location in the ControlCollection object.
Protected property Owner Gets the ASP.NET server control to which the ControlCollection object belongs.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection of controls.
Top
  Name Description
Public method Add Adds the specified Control object to the collection.
Public method AddAt Adds the specified Control object to the collection at the specified index location.
Public method Clear Removes all controls from the current server control's ControlCollection object.
Public method Contains Determines whether the specified server control is in the parent server control's ControlCollection object.
Public method CopyTo Copies the child controls stored in the ControlCollection object to an System.Array object, beginning at the specified index location in the System.Array.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Retrieves an enumerator that can iterate through the ControlCollection object.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Retrieves the index of a specified Control object in the collection.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes the specified server control from the parent server control's ControlCollection object.
Public method RemoveAt Removes a child control, at the specified index location, from the ControlCollection object.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast(Of TResult) Converts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType(Of TResult) Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

You can access any of the properties and methods of the ControlCollection class through the Control.Controls property. Since the Control class is the base class for all ASP.NET server controls, all server controls inherit this property.

For more information about collections, see Collections and Data Structures.

The following code example overrides the Control.CreateChildControls method to create two controls, both instances of the custom class named ChildControl, which has a string property named Message. When created, the two controls are added to the ControlCollection. The Add method is called on each of these controls to add them to the class that contains this version of Control.CreateChildControls. The ChildControlsCreated property is set to true so that these controls will not be created again unnecessarily.



      protected override void CreateChildControls()
      {               
         // Creates a new ControlCollection. 
         this.CreateControlCollection();

         // Create child controls.
          ChildControl firstControl = new ChildControl();
         firstControl.Message = "FirstChildControl";

         ChildControl secondControl = new ChildControl();
         secondControl.Message = "SecondChildControl";

         Controls.Add(firstControl);
         Controls.Add(secondControl);

         // Prevent child controls from being created again.
         ChildControlsCreated = true;
      }



.NET Framework

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(2000 characters remaining)
Community Content Add
Annotations FAQ