Home Library Learn Downloads Support Community
Sign in | United States - English | |
2 out of 9 rated this helpful - Rate this topic

Control.EnableViewState Property

.NET Framework 2.0

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.

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

C#
C++
VB
Copy 
[ThemeableAttribute(false)] 
public virtual bool EnableViewState { get; set; }
J#
Copy 
/** @property */
public boolean get_EnableViewState ()

/** @property */
public void set_EnableViewState (boolean value)
JScript
Copy 
public function get EnableViewState () : boolean

public function set EnableViewState (value : boolean)

Property Value

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

You must enable view state for the server control to maintain its state across HTTP requests.

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 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 on new state management functionality in ASP.NET 2.0, see What's New in ASP.NET State Management.

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

The following example sets the EnableViewState property to false.

C#
VB
Copy 
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;
      
}
J#
Copy 
void Page_Load(Object sender, System.EventArgs e)
{
    DataBind();
    // Set EnableViewState to false to disable saving of view state 
    // information.
    myControl.set_EnableViewState(false);
    if (!(get_IsPostBack())) {
        display.set_Enabled(false);
   }
} //Page_Load

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

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ