Control.ViewState プロパティ

同一のページに対する複数の要求にわたって、サーバー コントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)

構文

'宣言
Protected Overridable ReadOnly Property ViewState As StateBag
'使用
Dim value As StateBag

value = Me.ViewState

protected virtual StateBag ViewState { get; }

protected:
virtual property StateBag^ ViewState {
    StateBag^ get ();
}

/** @property */
protected StateBag get_ViewState ()

protected function get ViewState () : StateBag

適用できません。

プロパティ値

サーバー コントロールのビューステートの情報を格納している StateBag クラスのインスタンス。

解説

サーバー コントロールのビューステートは、そのサーバー コントロールのプロパティ値をすべて累積した値によって表されます。複数の HTTP 要求にわたってこれらの値を保存するために、ASP.NET サーバー コントロールは StateBag クラスのインスタンスであるこのプロパティを使用して、プロパティ値を格納します。これらの値は、後続の要求が処理されるときに、変数として HTML 非表示入力要素に渡されます。サーバー コントロールのビューステートの保存の詳細については、「ASP.NET の状態管理」を参照してください。

ビューステートは、既定ではすべてのサーバー コントロールで有効にされていますが、無効にする必要がある場合もあります。詳細については、「高パフォーマンス ASP.NET アプリケーションの開発」を参照してください。

ディクショナリとその使用方法の詳細については、「コレクションとデータ構造体」を参照してください。

使用例

コントロールの ViewState プロパティから値を取得し、格納する Text プロパティを実装する例を次に示します。

' Add property values to view state with set; 
' retrieve them from view state with get.
Public Property [Text]() As String
    Get
        Dim o As Object = ViewState("Text")
        If (IsNothing(o)) Then
            Return String.Empty
        Else
            Return CStr(o)
        End If
    End Get
    Set(ByVal value As String)
        ViewState("Text") = value
    End Set
End Property

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;
    }
}

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

// 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 Server 2000 SP4,Windows CE,Windows Millennium Edition,Windows Mobile for Pocket PC,Windows Mobile for Smartphone,Windows Server 2003,Windows XP Media Center Edition,Windows XP Professional x64 Edition,Windows XP SP2,Windows XP Starter Edition

Microsoft .NET Framework 3.0 は Windows Vista,Microsoft Windows XP SP2,および Windows Server 2003 SP1 でサポートされています。

バージョン情報

.NET Framework

サポート対象 : 3.0,2.0,1.1,1.0

参照

関連項目

Control クラス
Control メンバ
System.Web.UI 名前空間
StateBag

その他の技術情報

ASP.NET の状態管理