Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Control.CreateControlCollection Method

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
protected virtual ControlCollection CreateControlCollection()

Return Value

Type: System.Web.UI.ControlCollection
A ControlCollection object to contain the current server control's child server controls.

Override this method in a custom server control if you have created a collection object that is derived from the ControlCollection class. You can then instantiate that collection class in the override of this method.

The following code example overrides the CreateControlCollection method to create an instance of a CustomControlCollection class, which inherits from the ControlCollection class.

C#
VB
Copy 

		// Override the CreateControlCollection method to 
		// write to the Trace object when tracing is enabled
		// for the page or application in which this control
		// is included.   
		protected override ControlCollection CreateControlCollection()
		{
			return new CustomControlCollection(this);
		}

The following code example uses the CreateControlCollection method in a custom server control override of the CreateChildControls method. The new collection is created, and then populated with two child controls, firstControl and secondControl.

C#
VB
Copy 


      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.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, 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.

Did you find this helpful?
(1500 characters remaining)