Export (0) Print
Expand All

IStateFormatter.Serialize Method

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

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

string Serialize(
	Object state
)

Parameters

state
Type: System.Object

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

Return Value

Type: System.String
A string that represents a Web server control's view state.

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

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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft