This documentation is archived and is not being maintained.

Parameter.ViewState Property

Note: This property is new in the .NET Framework version 2.0.

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

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

protected StateBag ViewState { get; }
/** @property */
protected StateBag get_ViewState ()

protected function get ViewState () : StateBag

Property Value

An instance of StateBag that contains the Parameter object's view-state information.

A parameter's view state is the accumulation of all its property values. 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. View state is enabled for all server controls by defaultDeveloping High-Performance ASP.NET Applications.

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

The following code example demonstrates how to use the view-state object to store parameter object state in a class that extends the Parameter class. This code example is part of a larger example provided for the Parameter class overview.

// The DataValue can be any arbitrary object and is stored in ViewState.
public object DataValue {
  get {
    return ViewState["Value"];
  }
  set {
    ViewState["Value"] = value;
  }
}

// The DataValue can be any arbitrary object and is stored in ViewState.
/** @property 
 */
public Object get_DataValue()
{
    return get_ViewState().get_Item("Value");
} //get_DataValue


/** @property 
 */
public void set_DataValue(Object value)
{
    get_ViewState().set_Item("Value", value);
} //set_DataValue

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
Show: