SoapFormatter Class
Collapse the table of content
Expand the table of content

SoapFormatter Class


Serializes and deserializes an object, or an entire graph of connected objects, in SOAP format.

Namespace:   System.Runtime.Serialization.Formatters.Soap
Assembly:  System.Runtime.Serialization.Formatters.Soap (in System.Runtime.Serialization.Formatters.Soap.dll)


public ref class SoapFormatter sealed : IRemotingFormatter, IFormatter


Initializes a new instance of the SoapFormatter class with default property values.

System_CAPS_pubmethodSoapFormatter(ISurrogateSelector^, StreamingContext)

Initializes a new instance of the SoapFormatter class with the specified ISurrogateSelector and StreamingContext.


Gets or sets the behavior of the deserializer with regards to finding and loading assemblies.


Gets or sets the SerializationBinder that controls the binding of a serialized object to a type.


Gets or sets the StreamingContext used with this SoapFormatter.


Gets or sets the TypeFilterLevel of automatic deserialization for .NET Framework remoting.


Gets or sets the SurrogateSelector that controls type substitution during serialization and deserialization.


Gets or sets the ISoapMessage into which the SOAP top object is deserialized.


Gets or sets the format in which type descriptions are laid out in the serialized stream.


Deserializes the data on the provided stream and reconstitutes the graph of objects.

System_CAPS_pubmethodDeserialize(Stream^, HeaderHandler^)

Deserializes the stream into an object graph with any headers in that stream being handled by the given HeaderHandler.


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


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


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

System_CAPS_pubmethodSerialize(Stream^, Object^)

Serializes an object or graph of objects with the specified root to the given Stream.

System_CAPS_pubmethodSerialize(Stream^, Object^, array<Header^>^)

Serializes an object or graph of objects with the specified root to the given Stream in the SOAP Remote Procedure Call (RPC) format.


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


Beginning with the .NET Framework 2.0, this class is obsolete. Use BinaryFormatter instead.

The SoapFormatter and BinaryFormatter classes implement the IRemotingFormatter interface to support remote procedure calls (RPCs), and the IFormatter interface (inherited by the IRemotingFormatter) to support serialization of a graph of objects. The SoapFormatter class also supports RPCs with ISoapMessage objects, without using the IRemotingFormatter functionality.

During RPCs, the IRemotingFormatter interface allows the specification of two separate object graphs: the graph of objects to serialize, and an additional graph that contains an array of header objects that convey information about the remote function call (for example, transaction ID or a method signature). For proper serialization, the root object of the first graph must be an object that implements either the IMethodCallMessage interface or the IMethodReturnMessage interface.

During deserialization of an RPC, a HeaderHandler delegate is specified to the Deserialize method of the formatter. The remoting infrastructure uses the HeaderHandler delegate to produce an object that supports the ISerializable interface. This object contains the information stored in the headers, and becomes the root of the graph returned by the deserializer.

The SoapFormatter can also handle RPCs that are produced with objects that implement the ISoapMessage interface. To create an RPC without using the IRemotingFormatter functionality, place an object that supports the ISoapMessage interface at the root of a graph being serialized. To deserialize an RPC created in this manner the TopObject property must be set to another object that supports the ISoapMessage interface, and contains the relevant remote call information.

TimeSpan objects are serialized according to the ISO 8601: 1998 section "Alternative" standard.

The SoapFormatter does not support serialization compatibility between versions of the .NET Framework. Serialization between versions 1.1 and 2.0 types in the Framework often fails. The following actions can be taken to remedy this issue:

  • Convert to use the BinaryFormatter, which provides compatibility between 1.1 and 2.0.

  • Convert existing persisted data to the new format.

  • Convert all producers and consumers of serialized data to version 2.0.

  • Avoid using types that changed from 1.1 to 2.0.

#using <system.dll>
#using <system.runtime.serialization.formatters.soap.dll>

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization;
using namespace System::Runtime::Serialization::Formatters::Soap;
void Serialize()

   // Create a hashtable of values that will eventually be serialized.
   Hashtable^ addresses = gcnew Hashtable;
   addresses->Add( "Jeff", "123 Main Street, Redmond, WA 98052" );
   addresses->Add( "Fred", "987 Pine Road, Phila., PA 19116" );
   addresses->Add( "Mary", "PO Box 112233, Palo Alto, CA 94301" );

   // To serialize the hashtable (and its keys/values), 
   // you must first open a stream for writing.
   // We will use a file stream here.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Create );

   // Construct a SoapFormatter and use it 
   // to serialize the data to the stream.
   SoapFormatter^ formatter = gcnew SoapFormatter;
      formatter->Serialize( fs, addresses );
   catch ( SerializationException^ e ) 
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );


void Deserialize()

   // Declare the hashtable reference.
   Hashtable^ addresses = nullptr;

   // Open the file containing the data that we want to deserialize.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Open );
      SoapFormatter^ formatter = gcnew SoapFormatter;

      // Deserialize the hashtable from the file and 
      // assign the reference to our local variable.
      addresses = dynamic_cast<Hashtable^>(formatter->Deserialize( fs ));
   catch ( SerializationException^ e ) 
      Console::WriteLine( "Failed to deserialize. Reason: {0}", e->Message );

   // To prove that the table deserialized correctly, 
   // display the keys/values to the console.
   IEnumerator^ myEnum = addresses->GetEnumerator();
   while ( myEnum->MoveNext() )
      DictionaryEntry^ de = safe_cast<DictionaryEntry^>(myEnum->Current);
      Console::WriteLine( " {0} lives at {1}.", de->Key, de->Value );

int main()

.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
© 2016 Microsoft