Language

SoapOption Enum

Definition

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

This enumeration supports a bitwise combination of its member values.

This API supports the product infrastructure and is not intended to be used directly from your code.

public enum class SoapOption
[System.Flags]
[System.Serializable]
public enum SoapOption
[System.Flags]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public enum SoapOption
[]
[]
type SoapOption = 
[]
[]
[]
type SoapOption = 
Public Enum SoapOption
Inheritance
SoapOption
Attributes

Fields

Name Value Description
None 0

The default option indicating that no extra options are selected.

AlwaysIncludeTypes 1

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.

XsdString 2

Indicates that the output SOAP string type in a SOAP Envelope uses the XSD prefix, and that the resulting XML does not have an ID attribute for the string.

EmbedAll 4

Indicates that SOAP will be generated without references. This option is currently not implemented.

Option1 8

Public reserved option for temporary interop conditions; the use will change.

Option2 16

Public reserved option for temporary interop conditions; the use will change.

Remarks

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

For example, while a class by default (with the SoapOptions.None enumeration value) might be remoted in the SOAP format as:

10  
hello  
  
  
  
  
Hello World  
hello < world  
<  
< world  
  

Remoting serialization with the SoapOptions.XsdString option produces the following XML:

10  
hello  
hello  
  
  
  
Hello World  
hello < world  
<  
< world  
hello < world  

For more information about SOAP envelopes, see www.w3.org/tr/soap/#_Toc478383494.

Applies to