IStateFormatter インターフェイス

定義

名前空間:

System.Web.UI

アセンブリ:

System.Web.dll

オブジェクト グラフをシリアル化および逆シリアル化するために型が実装するメソッドを定義します。

public interface class IStateFormatter

public interface IStateFormatter

type IStateFormatter = interface

Public Interface IStateFormatter

派生

System.Web.UI.ObjectStateFormatter

例

次のコード例では、ビューとコントロールの状態を PageStatePersister Web サーバー上のストリームに保存するオブジェクトを作成する方法を示します。 クラスはStreamPageStatePersister、 メソッドと Save メソッドをオーバーライドLoadしてページ状態情報を抽出および保存する方法を示しています。 これらのメソッドは、 IStateFormatter クラスから継承されたインターフェイスを PageStatePersister 使用して、ビューステートをシリアル化および逆シリアル化します。 このコード例は、PageStatePersister クラスのために提供されている大規模な例の一部です。

namespace Samples.AspNet.CS
{

    using System;
    using System.IO;
    using System.Security.Permissions;
    using System.Web;
    using System.Web.UI;

    //
    // The StreamPageStatePersister is an example view state
    // persistence mechanism that persists view and control
    // state on the Web server.
    //
    [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
    public class StreamPageStatePersister : PageStatePersister
    {

        public StreamPageStatePersister(Page page)
            : base(page)
        {
        }
        //
        // 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();
        }
        //
        // 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.");
                }
            }
        }
        // Return a secure Stream for your environment.
        private Stream GetSecureStream()
        {
            // You must provide the implementation to build
            // a secure Stream for your environment.
            return null;
        }
    }
}

Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI

Namespace Samples.AspNet.VB

    ' The StreamPageStatePersister is an example view state
    ' persistence mechanism that persists view and control
    ' state on the Web server.
    '
    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class StreamPageStatePersister
        Inherits PageStatePersister


        Public Sub New(ByVal page As Page)
            MyBase.New(page)
        End Sub

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

        '
        ' 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
        ' Return a secure Stream for your environment.
        Private Function GetSecureStream() As Stream
            ' You must provide the implementation to build
            ' a secure Stream for your environment.
            Return Nothing
        End Function
    End Class
End Namespace

注釈

インターフェイスは IStateFormatter 、ASP.NET Web サーバー コントロールがそのプロパティで保持する状態をシリアル化および逆シリアル化するために型が実装できるメソッドを ViewState 定義します。 このインフラストラクチャは、 クラスから PageStatePersister 派生したクラスによって使用され、要求間の ASP.NET ページの状態を維持します。 既定では、ASP.NET ページの状態は クラスのインスタンスによってシリアル化および逆シリアル化されます。ただし、サイトおよびアダプターの ObjectStateFormatter 開発者は、この作業を実行するために独自の型にインターフェイスを実装 IStateFormatter できます。

Web サーバー コントロールの状態管理とビューステートの詳細については、「 ASP.NET 状態管理の概要 」および「 動的 Web サーバー コントロール」および「ビューステート」を参照してください。

メソッド

Deserialize(String)	オブジェクトの状態グラフをそのシリアル化された文字列の形式から逆シリアル化します。
Serialize(Object)	ASP.NET Web サーバー コントロールの状態を文字列形式にシリアル化します。

こちらもご覧ください

• PageStatePersister
• LosFormatter
• ObjectStateFormatter