ObjectStateFormatter Class
Serializes and deserializes object graphs that represent the state of an object. This class cannot be inherited.
Assembly: System.Web (in System.Web.dll)
| Name | Description | |
|---|---|---|
 | ObjectStateFormatter() | Initializes a new instance of the ObjectStateFormatter class. |
| Name | Description | |
|---|---|---|
| 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.) |
| GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
| GetType() | |
| 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.) |
| Name | Description | |
|---|---|---|
  | IFormatter::Deserialize(Stream^) | This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see ObjectStateFormatter::Deserialize. |
| IFormatter::Serialize(Stream^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see ObjectStateFormatter::Serialize. |
| IStateFormatter::Deserialize(String^) | For a description of this member, see ObjectStateFormatter::Deserialize. |
| IStateFormatter::Serialize(Object^) | For a description of this member, see ObjectStateFormatter::Serialize. |
 | IFormatter::Binder | For a description of this member, see Formatter::Binder. |
| IFormatter::Context | For a description of this member, see IFormatter::Context. |
| IFormatter::SurrogateSelector | For a description of this member, see System.Runtime.Serialization::SurrogateSelector. |
The ObjectStateFormatter class serializes and deserializes object state graphs in a compact format.
ObjectStateFormatter 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 ObjectStateFormatter 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.
String [] | |||
null (Nothing) | |||
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 ObjectStateFormatter class is not optimized for any of these serializable types.
If the ObjectStateFormatter 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 ObjectStateFormatter 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.
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.