This documentation is archived and is not being maintained.
Formatter Class
Visual Studio 2010
Provides base functionality for the common language runtime serialization formatters.
Assembly: mscorlib (in mscorlib.dll)
The Formatter type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Binder | When overridden in a derived class, gets or sets the SerializationBinder used with the current formatter. |
![]() | Context | When overridden in a derived class, gets or sets the StreamingContext used for the current serialization. |
![]() | SurrogateSelector | When overridden in a derived class, gets or sets the ISurrogateSelector used with the current formatter. |
| Name | Description | |
|---|---|---|
![]() | Deserialize | When overridden in a derived class, deserializes the stream attached to the formatter when it was created, creating a graph of objects identical to the graph originally serialized into that stream. |
![]() | 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.) |
![]() | GetNext | Returns the next object to serialize, from the formatter's internal work queue. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Schedule | Schedules an object for later serialization. |
![]() | Serialize | When overridden in a derived class, serializes the graph of objects with the specified root to the stream already attached to the formatter. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | WriteArray | When overridden in a derived class, writes an array to the stream already attached to the formatter. |
![]() | WriteBoolean | When overridden in a derived class, writes a Boolean value to the stream already attached to the formatter. |
![]() | WriteByte | When overridden in a derived class, writes an 8-bit unsigned integer to the stream already attached to the formatter. |
![]() | WriteChar | When overridden in a derived class, writes a Unicode character to the stream already attached to the formatter. |
![]() | WriteDateTime | When overridden in a derived class, writes a DateTime value to the stream already attached to the formatter. |
![]() | WriteDecimal | When overridden in a derived class, writes a Decimal value to the stream already attached to the formatter. |
![]() | WriteDouble | When overridden in a derived class, writes a double-precision floating-point number to the stream already attached to the formatter. |
![]() | WriteInt16 | When overridden in a derived class, writes a 16-bit signed integer to the stream already attached to the formatter. |
![]() | WriteInt32 | When overridden in a derived class, writes a 32-bit signed integer to the stream. |
![]() | WriteInt64 | When overridden in a derived class, writes a 64-bit signed integer to the stream. |
![]() | WriteMember | Inspects the type of data received, and calls the appropriate Write method to perform the write to the stream already attached to the formatter. |
![]() | WriteObjectRef | When overridden in a derived class, writes an object reference to the stream already attached to the formatter. |
![]() | WriteSByte | When overridden in a derived class, writes an 8-bit signed integer to the stream already attached to the formatter. |
![]() | WriteSingle | When overridden in a derived class, writes a single-precision floating-point number to the stream already attached to the formatter. |
![]() | WriteTimeSpan | When overridden in a derived class, writes a TimeSpan value to the stream already attached to the formatter. |
![]() | WriteUInt16 | When overridden in a derived class, writes a 16-bit unsigned integer to the stream already attached to the formatter. |
![]() | WriteUInt32 | When overridden in a derived class, writes a 32-bit unsigned integer to the stream already attached to the formatter. |
![]() | WriteUInt64 | When overridden in a derived class, writes a 64-bit unsigned integer to the stream already attached to the formatter. |
![]() | WriteValueType | When overridden in a derived class, writes a value of the given type to the stream already attached to the formatter. |
| Name | Description | |
|---|---|---|
![]() | m_idGenerator | Contains the ObjectIDGenerator used with the current formatter. |
![]() | m_objectQueue | Contains a Queue of the objects left to serialize. |
Formatter is the abstract base class for all runtime serialization formatters, and provides some helper methods for implementing the IFormatter interface. The Formatter also manages queuing objects for serialization and generating IDs on a per-object basis.
Notes to InheritorsWhen you inherit from Formatter, you must override the following members:
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.
Show:
