Control.IsTrackingViewState Property (System.Web.UI)

.NET Framework Class Library

Control..::.IsTrackingViewState Property

Gets a value that indicates whether the server control is saving changes to its view state.

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

Protected ReadOnly Property IsTrackingViewState As Boolean
	Get

protected bool IsTrackingViewState { get; }

protected:
property bool IsTrackingViewState {
	bool get ();
}

member IsTrackingViewState : bool

Property Value

Type: System..::.Boolean
true if the control is marked to save its state; otherwise, false.

Remarks

For a sample custom server control that uses this property, see Templated Server Control Example

Examples

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 ControlCollection object. ControlCollection..::.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 Overrides Sub DataBind()
   MyBase.OnDataBinding(EventArgs.Empty)
   ' Reset the control's state.
   Controls.Clear()
   ' Check for HasChildViewState to avoid unnecessary calls to ClearChildViewState.
   If HasChildViewState Then
      ClearChildViewState()
   End If
   ChildControlsCreated = True
   If Not IsTrackingViewState Then
      TrackViewState()
   End If
End Sub


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

Version Information

.NET Framework

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

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Control Class

System.Web.UI Namespace