PageStatePersister.ControlState プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

PageStatePersister.ControlState プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

オブジェクトを取得または設定します。このオブジェクトは、現在の Page オブジェクトによって格納されているコントロールが Web サーバーへの HTTP 要求間で永続化するために使用しているデータを表します。

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

Visual Basic (宣言)

Public Property ControlState As
 Object

Visual Basic (使用法)

Dim instance As PageStatePersister
Dim value As Object

value = instance.ControlState

instance.ControlState = value

public Object ControlState { get; set;
 }

C++

public:
property Object^ ControlState {
    Object^ get ();
    void set (Object^ value);
}

/** @property */
public Object get_ControlState ()

/** @property */
public void set_ControlState (Object value)

JScript

public function get ControlState
 () : Object

public function set ControlState
 (value : Object)

プロパティ値
ビューステートデータを格納しているオブジェクト。

解説

コントロールの状態は、Web サーバーコントロールが機能するために必要な重要なビューステートデータで構成されたオブジェクトであり、通常のビューステート情報とは別のオブジェクトに格納されます。ビューステートが Page レベルで無効になっている場合、コントロールの状態データは変更されませんが、追加の実装手順を使用する必要があります。コントロールの開発時における ViewState プロパティおよびコントロールの状態の使い方の詳細については、「ASP.NET カスタムサーバーコントロールの開発」を参照してください。

使用例

PageStatePersister クラスの派生クラスで ControlState プロパティを初期化する方法を次のコード例に示します。この例では、ControlState プロパティが Pair オブジェクトの Second フィールドに割り当てられ、ObjectStateFormatter クラスを使用してシリアル化されます。Load メソッドの呼び出し時に、ObjectStateFormatter クラスを使用してビューステートとコントロールの状態情報を逆シリアル化し、結果として生成される Pair オブジェクトの Second フィールドから、ControlState プロパティを初期化しています。このコード例は、PageStatePersister クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'
' Load ViewState and ControlState.
'
Public Overrides Sub Load()

    Dim stateStream As Stream
    stateStream = GetSecureStream()

    ' Read the state string, using the StateFormatter.
    Dim reader As New StreamReader(stateStream)

    Dim serializedStatePair As String
    serializedStatePair = reader.ReadToEnd
    Dim statePair As Pair

    Dim formatter As IStateFormatter
    formatter = Me.StateFormatter

    ' Deserilize returns the Pair object that is serialized in
    ' the Save method.      
    statePair = CType(formatter.Deserialize(serializedStatePair), Pair)

    ViewState = statePair.First
    ControlState = statePair.Second
    reader.Close()
    stateStream.Close()
End Sub ' Load

//
// Load ViewState and ControlState.
//
public override void Load()
{
    Stream stateStream = GetSecureStream();

    // Read the state string, using the StateFormatter.
    StreamReader reader = new StreamReader(stateStream);

    IStateFormatter formatter = this.StateFormatter;
    string fileContents = reader.ReadToEnd();

    // Deserilize returns the Pair object that is serialized in
    // the Save method.
    Pair statePair = (Pair)formatter.Deserialize(fileContents);

    ViewState = statePair.First;
    ControlState = statePair.Second;
    reader.Close();
    stateStream.Close();
}