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

Control.ViewState Property

.NET Framework 2.0

Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

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

C#
C++
VB
Copy 
protected virtual StateBag ViewState { get; }
J#
Copy 
/** @property */
protected StateBag get_ViewState ()
JScript
Copy 
protected function get ViewState () : StateBag

Property Value

An instance of the StateBag class that contains the server control's view-state information.

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 server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see ASP.NET State Management.

View state is enabled for all server controls by default, but there are circumstances in which you will want to disable it. For more information, see Developing High-Performance ASP.NET Applications.

For information about dictionaries and how to use them, see Collections and Data Structures.

The following example demonstrates implementing a Text property that stores and retrieves its value from its control's ViewState property.

C#
VB
Copy 
private const int defaultFontSize = 3;

// Add property values to view state with set;
// retrieve them from view state with get.
public String Text
{
    get 
    { 
        object o = ViewState["text"]; 
        return (o == null)? String.Empty : (string)o;
    }

    set
    {
        ViewState["Text"] = value;
    }
}
J#
Copy 
// Add property values to view state with set;
// retrieve them from view state with get.
/** @property 
 */
public String get_Text()
{
    return ((String)(get_ViewState().get_Item("Text")));
} //get_Text

/** @property 
 */
public void set_Text(String value)
{
    get_ViewState().set_Item("Text", value);
} //set_Text
JScript
Copy 
// Add property values to view state with set;
// retrieve them from view state with get.
public function get Text() : String 
{
       return String(ViewState["Text"]);
}

public function set Text(value : String)
{
       ViewState["Text"] = value;
}

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