System.Web.UI.WebControls.WebControl.SaveViewState Method

Saves any state that was modified after the Style.TrackViewState method was invoked.

Syntax

protected override object SaveViewState ()

Returns

An object that contains the current view state of the control; otherwise, if there is no view state associated with the control, null.

Remarks

The WebControl.SaveViewState method is used primarily by control developers.

View state is the cumulative values of the properties for a server control. These values are placed automatically in the System.Web.UI.Control.ViewState property for the server control, which is an instance of the System.Web.UI.StateBag class. The System.Web.UI.Control.ViewState property value is then persisted to a string object after the save state stage of the life cycle for the server control. For more information, see Introduction to the ASP.NET Page Life Cycle.

When view state is saved, this string object is returned to the client as a variable that is stored in a hidden HTML input element. When you author custom server controls, you can improve efficiency by overriding the WebControl.SaveViewState method and modifying the System.Web.UI.Control.ViewState property for your server control. For more information, see ASP.NET State Management Overview.

Requirements

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0