Export (0) Print
Expand All

Control.CreateControlCollection Method

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)

'Declaration
Protected Overridable Function CreateControlCollection As ControlCollection
'Usage
Dim returnValue As ControlCollection 

returnValue = Me.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.

' 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 Overrides Function CreateControlCollection() As ControlCollection
    Return New CustomControlCollection(Me)
End Function

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.

Protected Overrides Sub CreateChildControls()
   ' Creates a new ControlCollection.  
   Me.CreateControlCollection()

   ' Create child controls. 
   Dim firstControl As New ChildControl()
   firstControl.Message = "FirstChildControl" 

   Dim secondControl As New ChildControl()
   secondControl.Message = "SecondChildControl"

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

   ' Prevent child controls from being created again.
   ChildControlsCreated = True 
End Sub 'CreateChildControls

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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

Community Additions

ADD
Show:
© 2014 Microsoft