Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Control.TrackViewState Method

Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control.ViewState property.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)
protected virtual void TrackViewState ()
protected void TrackViewState ()
protected function TrackViewState ()
Not applicable.

This method is called automatically at the end of the Init event in the server control's lifecycle.

Invoke this method when you develop templated data-bound controls. This method alerts ASP.NET to monitor changes to a server control's view state, which is required when you override the Control.DataBind method.

The following example overrides the DataBind method in a custom ASP.NET server control. It begins by calling the base OnDataBinding method and then uses the Clear method to delete all the child controls and the ClearChildViewState method to delete any saved view-state settings for those child controls. Finally, the ChildControlsCreated property is set to true. The control then uses the IsTrackingViewState property to determine whether view-state change tracking is enabled for the control. If it is not enabled, the TrackViewState method is called.

public override void DataBind() 
{
   base.OnDataBinding(EventArgs.Empty);
   // Reset the control's state.
   Controls.Clear();
   // Check for HasChildViewState to avoid unnecessary calls to ClearChildViewState.
   if (HasChildViewState)
      ClearChildViewState();
   ChildControlsCreated = true;
   if (!IsTrackingViewState)
      TrackViewState();
}

public void DataBind()
{
    super.OnDataBinding(EventArgs.Empty);

    // Reset the control's state.
    get_Controls().Clear();

    // Check for HasChildViewState to avoid unnecessary calls to 
    // ClearChildViewState.
    if (get_HasChildViewState()) {
        ClearChildViewState();
    }
    set_ChildControlsCreated(true);
    if (!(get_IsTrackingViewState())) {
        TrackViewState();
    }
} //DataBind

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, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.