Control.ClearChildState Method

Deletes the view-state and control-state information for all the server control's child controls.

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

Protected Sub ClearChildState

protected void ClearChildState ()
protected function ClearChildState ()
Not applicable.

The ClearChildState method clears all view-state and control-state information for child controls. It is equivalent to calling both the ClearChildViewState method and the ClearChildControlState method.

When recreating child controls of a Control object, use the ClearChildState method to clear child state so that it does not get applied to the new controls inadvertently.

The following code example demonstrates how to override the OnDataBinding method for a templated data-bound control. If the data source that the control binds to is populated, the control's ControlCollection collection is emptied using the Clear method, and the ClearChildState method is used to remove any state information that had been saved for the child controls.

' Override to create the repeated items from the DataSource.
Protected Overrides Sub OnDataBinding(E As EventArgs)

    If Not DataSource Is Nothing
        ' Clear any existing child controls.
        ' Clear any previous view state for the existing child controls.

        ' Iterate over the DataSource, creating a new item for each data item.
        Dim DataEnum As IEnumerator = DataSource.GetEnumerator()
        Dim I As Integer = 0
        Do While (DataEnum.MoveNext())

            ' Create an item.
            Dim Item As RepeaterItemVB = New RepeaterItemVB(I, DataEnum.Current)
            ' Initialize the item from the template.
            ' Add the item to the ControlCollection.

            I = I + 1

        ' Prevent child controls from being created again.
        ChildControlsCreated = true
        ' Store the number of items created in view state for postback scenarios.
        ViewState("NumItems") = I
    End If
End Sub

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0