StateFormatter Property
Collapse the table of content
Expand the table of content

PageStatePersister.StateFormatter Property

 

Gets an IStateFormatter object that is used to serialize and deserialize the state information contained in the ViewState and ControlState properties during calls to the Save and Load methods.

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

protected IStateFormatter StateFormatter { get; }

Property Value

Type: System.Web.UI.IStateFormatter

An instance of IStateFormatter that is used to serialize and deserialize object state.

You can override the StateFormatter property to provide your own view state formatter.

The following code example demonstrates how a class that derives from the PageStatePersister class accesses the StateFormatter property to retrieve an ObjectStateFormatter object, which is the default implementation of the IStateFormatter interface, to serialize view state and control state to a stream. This code example is part of a larger example provided for the PageStatePersister class.

//
// 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
Available since 2.0
Return to top
Show:
© 2016 Microsoft