IStateFormatter Schnittstelle

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Definiert Methoden, die ein Typ implementiert, um einen Objektgraphen zu serialisieren und zu deserialisieren.

public interface class IStateFormatter

public interface IStateFormatter

type IStateFormatter = interface

Public Interface IStateFormatter

Abgeleitet

System.Web.UI.ObjectStateFormatter

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein PageStatePersister Objekt erstellt wird, das den Ansichts- und Steuerungszustand in einem Stream auf dem Webserver speichert. Die StreamPageStatePersister -Klasse veranschaulicht, wie die Load Methoden und Save überschrieben werden, um Seitenzustandsinformationen zu extrahieren und zu speichern. Diese Methoden verwenden die IStateFormatter von der PageStatePersister -Klasse geerbte Schnittstelle, um den Ansichtszustand zu serialisieren und zu deserialisieren. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die PageStatePersister-Klasse bereitgestellt wird.

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

Hinweise

Die IStateFormatter Schnittstelle definiert Methoden, die ein Typ implementieren kann, um den Zustand zu serialisieren und zu deserialisieren, den ein ASP.NET Webserversteuerelement in seiner ViewState Eigenschaft verwaltet. Diese Infrastruktur wird von Klassen verwendet, die von der PageStatePersister -Klasse abgeleitet werden, um den Zustand der ASP.NET Seite zwischen Anforderungen beizubehalten. Standardmäßig wird ASP.NET Seitenzustand von einer Instanz der ObjectStateFormatter -Klasse serialisiert und deserialisiert. Website- und Adapterentwickler können die IStateFormatter Schnittstelle jedoch für ihre eigenen Typen implementieren, um diese Arbeit auszuführen.

Weitere Informationen zur Zustandsverwaltung und zum Ansichtszustand von Webserversteuerelementen finden Sie unter ASP.NET State Management Overview and Dynamic Web Server Controls and View State.

Methoden

Deserialize(String)	Deserialisiert einen Objektzustandsgraphen aus seiner serialisierten Zeichenfolgenform.
Serialize(Object)	Serialisiert den Zustand eines ASP.NET-Webserversteuerelement in Zeichenfolgenform.

Weitere Informationen

• PageStatePersister
• LosFormatter
• ObjectStateFormatter