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

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

PageStatePersister.StateFormatter プロパティ

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

Save メソッドおよび Load メッソドへの呼び出しで、ViewState プロパティおよび ControlState プロパティに格納されている状態情報のシリアル化と逆シリアル化に使用する IStateFormatter オブジェクトを取得します。

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

Visual Basic (宣言)

Protected ReadOnly Property
 StateFormatter As IStateFormatter

Visual Basic (使用法)

Dim value As IStateFormatter

value = Me.StateFormatter

protected IStateFormatter StateFormatter { get;
 }

C++

protected:
property IStateFormatter^ StateFormatter {
    IStateFormatter^ get ();
}

/** @property */
protected IStateFormatter get_StateFormatter ()

JScript

protected function get StateFormatter
 () : IStateFormatter

プロパティ値
オブジェクトの状態のシリアル化と逆シリアル化に使用する IStateFormatter のインスタンス。

解説

StateFormatter プロパティをオーバーライドすると、独自のビューステートフォーマッタを用意できます。

使用例

PageStatePersister クラスの派生クラスから StateFormatter プロパティにアクセスして、IStateFormatter インターフェイスの既定の実装である ObjectStateFormatter オブジェクトを取得し、ビューステートとコントロールの状態をシリアル化してストリームにする方法を次のコード例に示します。このコード例は、PageStatePersister クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'
' Persist any ViewState and ControlState.
'
Public Overrides Sub Save()

    If Not (ViewState Is
 Nothing) OrElse Not (ControlState
 Is Nothing) Then
        If Not (Page.Session Is
 Nothing) Then

            Dim stateStream As Stream
            stateStream = GetSecureStream()

            ' Write a state string, using the StateFormatter.
            Dim writer As New
 StreamWriter(stateStream)

            Dim formatter As IStateFormatter
            formatter = Me.StateFormatter

            Dim statePair As New
 Pair(ViewState, ControlState)

            Dim serializedState As String
            serializedState = formatter.Serialize(statePair)

            writer.Write(serializedState)
            writer.Close()
            stateStream.Close()
        Else
            Throw New InvalidOperationException("Session
 needed for StreamPageStatePersister.")
        End If
    End If
End Sub 'Save

//
// Persist any ViewState and ControlState.
//
public override void Save()
{

    if (ViewState != null || ControlState !=
 null)
    {
        if (Page.Session != null)
        {
            Stream stateStream = GetSecureStream();

            StreamWriter writer = new StreamWriter(stateStream);

            IStateFormatter formatter = this.StateFormatter;
            Pair statePair = new Pair(ViewState, ControlState);

            // Serialize the statePair object to a string.
            string serializedState = formatter.Serialize(statePair);

            writer.Write(serializedState);
            writer.Close();
            stateStream.Close();
        }
        else
            throw new InvalidOperationException("Session
 needed for StreamPageStatePersister.");
    }
}