ControlCollection Class
TOC
Collapse the table of content
Expand the table of content

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

NameDescription
System_CAPS_pubmethodControlCollection(Control)

Initializes a new instance of the ControlCollection class for the specified parent server control.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of server controls in the ControlCollection object for the specified ASP.NET server control.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the ControlCollection object is read-only.

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether the ControlCollection object is synchronized.

System_CAPS_pubpropertyItem[Int32]

Gets a reference to the server control at the specified index location in the ControlCollection object.

System_CAPS_protpropertyOwner

Gets the ASP.NET server control to which the ControlCollection object belongs.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the collection of controls.

NameDescription
System_CAPS_pubmethodAdd(Control)

Adds the specified Control object to the collection.

System_CAPS_pubmethodAddAt(Int32, Control)

Adds the specified Control object to the collection at the specified index location.

System_CAPS_pubmethodClear()

Removes all controls from the current server control's ControlCollection object.

System_CAPS_pubmethodContains(Control)

Determines whether the specified server control is in the parent server control's ControlCollection object.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the child controls stored in the ControlCollection object to an System.Array object, beginning at the specified index location in the System.Array.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Retrieves an enumerator that can iterate through the ControlCollection object.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(Control)

Retrieves the index of a specified Control object in the collection.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(Control)

Removes the specified server control from the parent server control's ControlCollection object.

System_CAPS_pubmethodRemoveAt(Int32)

Removes a child control, at the specified index location, from the ControlCollection object.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft