0 out of 5 rated this helpful - Rate this topic

Page.EnableViewState Property

Gets or sets a value indicating whether the page maintains its view state, and the view state of any server controls it contains, when the current page request ends.

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

public override bool EnableViewState { get; set; }
/** @property */
public boolean get_EnableViewState ()

/** @property */
public void set_EnableViewState (boolean value)

public override function get EnableViewState () : boolean

public override function set EnableViewState (value : boolean)

Property Value

true if the page maintains its view state; otherwise, false. The default is true.

Even if EnableViewState is false, there may be a hidden view state field rendered with the page that is used by ASP.NET to detect postback.

The following code example sets the EnableViewState property to false when the page is loaded. This disables view state for the Page object, meaning that neither view-state information for the page nor any controls contained by the page are saved.

public class WebPage : Page
{
   private MyForm myFormObj;
   private Label label1;
   private Label label2;
   private TextBox textBoxObj;
   private Button buttonObj;

   public WebPage()
   {
      Page.Init += new System.EventHandler(Page_Init);
   }

   private void Page_Load(object sender, System.EventArgs e)
   {
      // Comment the following line to maintain page view state.
      Page.EnableViewState = false;
      myFormObj.Method = "post";
      Controls.Add(myFormObj);
      textBoxObj.Text = "Welcome to .NET";

      label1.Text = "Enter a name";
      buttonObj.Text = "ClickMe";
      buttonObj.Click += new EventHandler(Button_Click);
      myFormObj.Controls.Add(label1);
      myFormObj.Controls.Add(textBoxObj);
      myFormObj.Controls.Add(buttonObj);
      myFormObj.Controls.Add(label2);
   }
   private void Button_Click(object sender, EventArgs e)
   {
      String temp = "<br>Name is " + textBoxObj.Text + "<br>";
      temp += "Saved content of previous page is " + ViewState["name"] as String;
      label2.Text = temp;
   }
   protected override void LoadViewState(object viewState)
   {
      if(viewState != null)
         base.LoadViewState(viewState);
   }
   protected override object SaveViewState()
   {
      ViewState["name"] = textBoxObj.Text;
      return base.SaveViewState();
   }
   private void Page_Init(object sender, EventArgs e)
   {
      this.Load += new System.EventHandler(this.Page_Load);

      myFormObj = new MyForm();
      label1 = new Label();
      label2 = new Label();
      textBoxObj = new TextBox();
      buttonObj = new Button();
   }
};

public class WebPage extends Page
{
    private MyForm myFormObj;
    private Label label1;
    private Label label2;
    private TextBox textBoxObj;
    private Button buttonObj;

    public WebPage()
    {
        get_Page().add_Init(new System.EventHandler(Page_Init));
    } //WebPage

    private void Page_Load(Object sender, System.EventArgs e)
    {
        // Comment the following line to maintain page view state.
        get_Page().set_EnableViewState(false);
        myFormObj.set_Method("post");
        get_Controls().Add(myFormObj);
        textBoxObj.set_Text("Welcome to .NET");
        label1.set_Text("Enter a name");
        buttonObj.set_Text("ClickMe");
        buttonObj.add_Click(new EventHandler(Button_Click));
        myFormObj.get_Controls().Add(label1);
        myFormObj.get_Controls().Add(textBoxObj);
        myFormObj.get_Controls().Add(buttonObj);
        myFormObj.get_Controls().Add(label2);
    } //Page_Load

    private void Button_Click(Object sender, EventArgs e)
    {
        String temp = "<br>Name is " + textBoxObj.get_Text() + "<br>";
        temp += "Saved content of previous page is " 
            + get_ViewState().get_Item("name");
        label2.set_Text(temp);
    } //Button_Click

    protected void LoadViewState(Object viewState)
    {
        if (viewState != null) {
            super.LoadViewState(viewState);
        }
    } //LoadViewState

    protected Object SaveViewState()
    {
        get_ViewState().set_Item("name", textBoxObj.get_Text());
        return super.SaveViewState();
    } //SaveViewState

    private void Page_Init(Object sender, EventArgs e)
    {
        this.add_Load(new System.EventHandler(this.Page_Load));
        myFormObj = new MyForm();
        label1 = new Label();
        label2 = new Label();
        textBoxObj = new TextBox();
        buttonObj = new Button();
    } //Page_Init
} //WebPage

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