Control.EnableViewState Property

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

public:
 virtual property bool EnableViewState { bool get(); void set(bool value); };

public virtual bool EnableViewState { get; set; }

[System.Web.UI.Themeable(false)]
public virtual bool EnableViewState { get; set; }

member this.EnableViewState : bool with get, set

[<System.Web.UI.Themeable(false)>]
member this.EnableViewState : bool with get, set

Public Overridable Property EnableViewState As Boolean

Property Value

Boolean

true if the server control maintains its view state; otherwise false. The default is true.

Attributes: ThemeableAttribute

Examples

The following example sets the EnableViewState property to false.

void Page_Load(object sender, System.EventArgs e)
{
      DataBind();
      // Set EnableViewState to false to disable saving of view state 
      // information.
      myControl.EnableViewState = false;
      if (!IsPostBack)
         display.Enabled = false;
      
}

Sub Page_Load(sender As Object, e As System.EventArgs)
   DataBind()
   ' Set EnableViewState to false to disable saving of view state 
   ' information.
   myControl.EnableViewState = False
   If Not IsPostBack Then
      display.Enabled = False
   End If 
End Sub

Remarks

View state enables a server control to maintain its state across HTTP requests. View state for a control is enabled if all of the following conditions are met:

The EnableViewState property for the page is set to true.
The EnableViewState property for the control is set to true.
The ViewStateMode property for the control is set to Enabled or inherits the Enabled setting.

For more information, see the ViewStateMode property.

A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET uses an instance of the StateBag class to store the property values. The values are then passed as a variable to a hidden field when subsequent requests are processed. For more information about view state, see ASP.NET View State Overview.

There are times when it is appropriate to disable view state, particularly to improve application performance. For example, if you are loading a database request into a server control, set this property to false. If you do not, processor time will be wasted loading view state into the server control that will only be overridden by the database query. If EnableViewState is false, you can use the control state to persist property information that is specific to a control and cannot be turned off like the view state property. For more information on the difference between control state and view state, see Control State vs. View State Example.

For information about how to enable or disable view state declaratively for an ASP.NET page, see @ Page.

Applies to

Dela via