Control.EnsureChildControls Method (System.Web.UI)

EnsureChildControls Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

Control.EnsureChildControls Method

Determines whether the server control contains child controls. If it does not, it creates child controls.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

Syntax

Visual Basic (Declaration)

Protected Overridable Sub EnsureChildControls

Visual Basic (Usage)

Me.EnsureChildControls

protected virtual void EnsureChildControls ()

C++

protected:
virtual void EnsureChildControls ()

protected void EnsureChildControls ()

JScript

protected function EnsureChildControls ()

Remarks

This method first checks the current value of the ChildControlsCreated property. If this value is false, the CreateChildControls method is called.

ASP.NET calls it this method when it needs to make sure that child controls have been created. In most cases, custom server control developers do not need to override this method. If you do override this method, use it in a similar fashion as its default behavior.

Example

The following example uses the EnsureChildControls method to ensure that the current server control has child controls. It then gets or sets a Text property for a child TextBox Web control in the current server control's ControlCollection object.

Visual Basic

' Ensure the current control has children,
' then get or set the Text property.

Public Property Value() As Integer
   Get
      Me.EnsureChildControls()
      Return Int32.Parse(CType(Controls(1), TextBox).Text)
   End Get
   Set
      Me.EnsureChildControls()
      CType(Controls(1), TextBox).Text = value.ToString()
   End Set
End Property

// Ensure the current control has children,
// then get or set the Text property.
 public int Value {
    get {
        this.EnsureChildControls();
        return Int32.Parse(((TextBox)Controls[1]).Text);
    }
    set {
        this.EnsureChildControls();
        ((TextBox)Controls[1]).Text = value.ToString();
    }
 }

// Ensure the current control has children,
// then get or set the Text property.
/** @property 
 */
public int get_Value()
{
    this.EnsureChildControls();
    return Int32.Parse(((TextBox)(get_Controls().get_Item(1))).get_Text());
} //get_Value

/** @property 
 */
public void set_Value(int value)
{
    this.EnsureChildControls();
    ((TextBox)get_Controls().get_Item(1)).set_Text(((Int32)value).ToString());
} //set_Value

JScript

// Ensure the current control has children,
// then get or set the Text property.
 public function get Value() : int
 {
       this.EnsureChildControls();
       return Int32.Parse(TextBox(Controls[1]).Text);
 }

 public function set Value(value : int)
 {
        this.EnsureChildControls();
        TextBox(Controls[1]).Text = value.ToString();
 }

Platforms

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

Control Class
Control Members
System.Web.UI Namespace
Controls
ChildControlsCreated
CreateChildControls