WebControl.SaveViewState メソッド

.NET Framework クラス ライブラリ リファレンス

WebControl.SaveViewState メソッド

TrackViewState メソッドの呼び出し後に変更された状態をすべて保存します。

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

Visual Basic (宣言)

Protected Overrides Function
 SaveViewState As Object

Visual Basic (使用法)

Dim returnValue As Object

returnValue = Me.SaveViewState

C#

protected override Object SaveViewState ()

C++

protected:
virtual Object^ SaveViewState () override

J#

protected Object SaveViewState ()

JScript

protected override function SaveViewState ()
 : Object

戻り値
コントロールの現在のビューステートを格納するオブジェクト。このコントロールに関連付けられたビューステートがない場合は null 参照 (Visual Basic では Nothing)。

解説

SaveViewState メソッドは、主にコントロールの開発者によって使用されます。

ビューステートは、サーバー コントロールのプロパティの累積値です。これらの値は、StateBag クラスのインスタンスである、サーバー コントロールの ViewState プロパティに自動的に配置されます。ViewState プロパティの値は、この後、サーバー コントロールの有効期間の保存状態の段階を終えても、文字列オブジェクトに永続化されます。詳細については、「ASP.NET ページのライフ サイクルの概要」を参照してください。

ビューステートを保存すると、この文字列オブジェクトは非表示の HTML input 要素に格納された変数としてクライアントに返されます。カスタム サーバー コントロールを作成する場合は、SaveViewState メソッドをオーバーライドし、サーバー コントロールの ViewState プロパティを変更することによって効率を向上させることができます。詳細については、「ASP.NET の状態管理」を参照してください。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WebControl クラス
WebControl メンバ
System.Web.UI.WebControls 名前空間
ViewState
IsTrackingViewState
その他の技術情報
ASP.NET カスタム サーバー コントロールの開発
コントロールの状態とビューステートの例
ASP.NET の状態管理
ASP.NET ページのライフ サイクルの概要