Control.CreateControlCollection メソッド

定義

サーバー コントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

protected:
 virtual System::Web::UI::ControlCollection ^ CreateControlCollection();
protected virtual System.Web.UI.ControlCollection CreateControlCollection ();
abstract member CreateControlCollection : unit -> System.Web.UI.ControlCollection
override this.CreateControlCollection : unit -> System.Web.UI.ControlCollection
Protected Overridable Function CreateControlCollection () As ControlCollection

戻り値

現在のサーバー コントロールの子サーバー コントロールを格納する ControlCollection オブジェクト。A ControlCollection object to contain the current server control's child server controls.

次のコード例では、CreateControlCollection メソッドをオーバーライドして、ControlCollection クラスから継承する CustomControlCollection クラスのインスタンスを作成します。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 override ControlCollection CreateControlCollection()
{
    return new CustomControlCollection(this);
}
' 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

次のコード例では、CreateChildControls メソッドのカスタムサーバーコントロールオーバーライドで CreateControlCollection メソッドを使用します。The following code example uses the CreateControlCollection method in a custom server control override of the CreateChildControls method. 新しいコレクションが作成され、firstControlsecondControlの2つの子コントロールが設定されます。The new collection is created, and then populated with two child controls, firstControl and secondControl.


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;
}

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


注釈

ControlCollection クラスから派生したコレクションオブジェクトを作成した場合は、カスタムサーバーコントロールでこのメソッドをオーバーライドします。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.

適用対象

こちらもご覧ください