IStateFormatter.Serialize(Object) Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Serializes ASP.NET Web server control state to string form.

public:
 System::String ^ Serialize(System::Object ^ state);

public string Serialize (object state);

abstract member Serialize : obj -> string

Public Function Serialize (state As Object) As String

Parameters

state: Object

The object that represents the view state of the Web server control to serialize to string form.

Returns

String

A string that represents a Web server control's view state.

Examples

The following code example demonstrates how the Serialize method persists view state information to a file. The Save method of the StreamPageStatePersister class uses the IStateFormatter interface inherited from the PageStatePersister class to serialize view state. This code example is part of a larger example provided for the IStateFormatter interface.

//
// 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.");
        }
    }
}

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

Remarks

Use the Serialize method to transform an object state graph to string form. Reconstitute a state object from the string using the Deserialize method.

Applies to

Dela via