This documentation is archived and is not being maintained.

SoapOption Enumeration

Specifies the SOAP configuration options for use with the SoapTypeAttribute class.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:  System.Runtime.Remoting.Metadata
Assembly:  mscorlib (in mscorlib.dll)

public enum SoapOption

Member nameDescription
NoneThe default option indicating that no extra options are selected.
AlwaysIncludeTypesIndicates that type will always be included on SOAP elements. This option is useful when performing SOAP interop with SOAP implementations that require types on all elements.
XsdStringIndicates that the output SOAP string type in a SOAP Envelope is using the XSD prefix, and that the resulting XML does not have an ID attribute for the string.

For example, while a class by default might be remoted in the SOAP format as

 <member2 id="ref-3">hello</member2>
 <member3 href="#ref-3"/>
 <member4 href="#ref-4"/>
 <member4shared href="#ref-4"/>
 <member5 href="#ref-5"/>
 <member6 id="ref-6" xsi:type="SOAP-ENC:string">Hello World</member6>
 <str1 id="ref-7">hello &#60; world</str1>
 <str2 id="ref-8">&#60;</str2>
 <str3 id="ref-9">&#60; world</str3>
 <str4 href="#ref-7"/>

remoting serialization with the XsdString option would produce the following XML.

 <member1 xsi:type="xsd:int">10</member1>
 <member2 xsi:type="xsd:string">hello</member2>
 <member3 xsi:type="xsd:string">hello</member3>
 <member4 href="#ref-3"/>
 <member4shared href="#ref-3"/>
 <member5 href="#ref-4"/>
 <member6 xsi:type="xsd:string">Hello World</member6>
 <str1 xsi:type="xsd:string">hello &#60; world</str1>
 <str2 xsi:type="xsd:string">&#60;</str2>
 <str3 xsi:type="xsd:string">&#60; world</str3>
 <str4 xsi:type="xsd:string">hello &#60; world</str4>

For more information about SOAP envelopes, see

EmbedAllIndicates that SOAP will be generated without references. This option is currently not implemented.
Option1Public reserved option for temporary interop conditions; the use will change.
Option2Public reserved option for temporary interop conditions; the use will change.

The SoapOption enumeration is used to specify instructions to the .NET Framework on how it will generate the SOAP.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0