Serializes and deserializes object graphs that represent the state of an object. This class cannot be inherited.
Assembly: System.Web (in System.Web.dll)
Thetype exposes the following members.
|Deserialize(Stream)||Deserializes an object state graph from its binary-serialized form that is contained in the specified Stream object.|
|Deserialize(String)||Deserializes an object state graph from its serialized base64-encoded string form.|
|Equals(Object)||Determines whether the specified Object is equal to the current Object. (Inherited from Object.)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Serves as a hash function for a particular type. (Inherited from Object.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|Serialize(Object)||Serializes an object state graph to a base64-encoded string.|
|Serialize(Stream, Object)||Serializes an object state graph to the specified Stream object.|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|IFormatter.Binder||For a description of this member, see Formatter.Binder.|
|IFormatter.Context||For a description of this member, see IFormatter.Context.|
|IFormatter.Deserialize||Infrastructure. For a description of this member, see ObjectStateFormatter.Deserialize.|
|IFormatter.Serialize||Infrastructure. For a description of this member, see ObjectStateFormatter.Serialize.|
|IFormatter.SurrogateSelector||For a description of this member, see System.Runtime.Serialization.SurrogateSelector.|
|IStateFormatter.Deserialize||For a description of this member, see ObjectStateFormatter.Deserialize.|
|IStateFormatter.Serialize||For a description of this member, see ObjectStateFormatter.Serialize.|
The class serializes and deserializes object state graphs in a compact format.
is used by the PageStatePersister class and classes that derive from it to serialize view state and control state. It is also used by the LosFormatter class to provide object state graph formatting for various parts of the ASP.NET infrastructure.
The class is optimized to serialize and format many common .NET Framework reference types, as well as constants. The following table lists the types that are optimized.
Additionally, while conventional string types and string arrays are written to and from a serialized binary writer unaltered, some strings are optimized by creating internal string tables. Strings are optimized using these tables if the string has an associated TypeConverter object or if the string is actually an instance of the IndexedString class.
Other types not listed above are binary-serialized using a BinaryFormatter object if they implement the ISerializable interface or are decorated with the SerializableAttribute attribute. The class is not optimized for any of these serializable types.
If the class encounters a type that is not serializable, an ArgumentException exception is thrown.
The following code example demonstrates how a class that derives from the PageStatePersister class accesses the StateFormatter property to retrieve an instance 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 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 'Save
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.