Formatter Class
TOC
Collapse the table of content
Expand the table of content

Formatter Class

 

Provides base functionality for the common language runtime serialization formatters.

This API is not CLS-compliant.

Namespace:   System.Runtime.Serialization
Assembly:  mscorlib (in mscorlib.dll)

System.Object
  System.Runtime.Serialization.Formatter

[SerializableAttribute]
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public abstract class Formatter : IFormatter

NameDescription
System_CAPS_protmethodFormatter()

Initializes a new instance of the Formatterclass.

NameDescription
System_CAPS_pubpropertyBinder

When overridden in a derived class, gets or sets the SerializationBinder used with the current formatter.

System_CAPS_pubpropertyContext

When overridden in a derived class, gets or sets the StreamingContext used for the current serialization.

System_CAPS_pubpropertySurrogateSelector

When overridden in a derived class, gets or sets the ISurrogateSelector used with the current formatter.

NameDescription
System_CAPS_pubmethodDeserialize(Stream)

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.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetNext(Int64)

Returns the next object to serialize, from the formatter's internal work queue.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodSchedule(Object)

Schedules an object for later serialization.

System_CAPS_pubmethodSerialize(Stream, Object)

When overridden in a derived class, serializes the graph of objects with the specified root to the stream already attached to the formatter.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodWriteArray(Object, String, Type)

When overridden in a derived class, writes an array to the stream already attached to the formatter.

System_CAPS_protmethodWriteBoolean(Boolean, String)

When overridden in a derived class, writes a Boolean value to the stream already attached to the formatter.

System_CAPS_protmethodWriteByte(Byte, String)

When overridden in a derived class, writes an 8-bit unsigned integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteChar(Char, String)

When overridden in a derived class, writes a Unicode character to the stream already attached to the formatter.

System_CAPS_protmethodWriteDateTime(DateTime, String)

When overridden in a derived class, writes a DateTime value to the stream already attached to the formatter.

System_CAPS_protmethodWriteDecimal(Decimal, String)

When overridden in a derived class, writes a Decimal value to the stream already attached to the formatter.

System_CAPS_protmethodWriteDouble(Double, String)

When overridden in a derived class, writes a double-precision floating-point number to the stream already attached to the formatter.

System_CAPS_protmethodWriteInt16(Int16, String)

When overridden in a derived class, writes a 16-bit signed integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteInt32(Int32, String)

When overridden in a derived class, writes a 32-bit signed integer to the stream.

System_CAPS_protmethodWriteInt64(Int64, String)

When overridden in a derived class, writes a 64-bit signed integer to the stream.

System_CAPS_protmethodWriteMember(String, Object)

Inspects the type of data received, and calls the appropriate Write method to perform the write to the stream already attached to the formatter.

System_CAPS_protmethodWriteObjectRef(Object, String, Type)

When overridden in a derived class, writes an object reference to the stream already attached to the formatter.

System_CAPS_protmethodWriteSByte(SByte, String)

When overridden in a derived class, writes an 8-bit signed integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteSingle(Single, String)

When overridden in a derived class, writes a single-precision floating-point number to the stream already attached to the formatter.

System_CAPS_protmethodWriteTimeSpan(TimeSpan, String)

When overridden in a derived class, writes a TimeSpan value to the stream already attached to the formatter.

System_CAPS_protmethodWriteUInt16(UInt16, String)

When overridden in a derived class, writes a 16-bit unsigned integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteUInt32(UInt32, String)

When overridden in a derived class, writes a 32-bit unsigned integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteUInt64(UInt64, String)

When overridden in a derived class, writes a 64-bit unsigned integer to the stream already attached to the formatter.

System_CAPS_protmethodWriteValueType(Object, String, Type)

When overridden in a derived class, writes a value of the given type to the stream already attached to the formatter.

NameDescription
System_CAPS_protfieldm_idGenerator

Contains the ObjectIDGenerator used with the current formatter.

System_CAPS_protfieldm_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.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft