Parameter.ViewState Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

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 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.

protected:
 property System::Web::UI::StateBag ^ ViewState { System::Web::UI::StateBag ^ get(); };

[System.ComponentModel.Browsable(false)]
protected System.Web.UI.StateBag ViewState { get; }

[<System.ComponentModel.Browsable(false)>]
member this.ViewState : System.Web.UI.StateBag

Protected ReadOnly Property ViewState As StateBag

Property Value

StateBag

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

Attributes: BrowsableAttribute

Examples

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.
Public Property DataValue() As Object
   Get
      Return ViewState("Value")
   End Get
   Set
      ViewState("Value") = value
   End Set
End Property

Remarks

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 default.

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

Applies to

Jaa