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.

[Visual Basic]
<Flags>
<Serializable>
Public Enum SoapOption
[C#]
[Flags]
[Serializable]
public enum SoapOption
[C++]
[Flags]
[Serializable]
__value public enum SoapOption
[JScript]
public
   Flags
 Serializable
enum SoapOption

Remarks

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

Members

Member name Description Value
AlwaysIncludeTypes Indicates 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. 1
EmbedAll Indicates that SOAP will be generated without references. 4
None The default option indicating that no extra options are selected. 0
Option1 This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. 8
Option2 This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. 16
XsdString Indicates 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

<member1>10</member1>
<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 www.w3.org/tr/soap/#_Toc478383494.

2

Requirements

Namespace: System.Runtime.Remoting.Metadata

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: Mscorlib (in Mscorlib.dll)

See Also

System.Runtime.Remoting.Metadata Namespace

Show: