Any suggestions? Export (0) Print
Expand All

SoapDocumentMethodAttribute Class

 

Applying the SoapDocumentMethodAttribute to a method specifies that SOAP messages to and from the method use Document formatting.

Namespace:   System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

System::Object
  System::Attribute
    System.Web.Services.Protocols::SoapDocumentMethodAttribute

[AttributeUsageAttribute(AttributeTargets::Method)]
public ref class SoapDocumentMethodAttribute sealed : Attribute

NameDescription
System_CAPS_pubmethodSoapDocumentMethodAttribute()

Initializes a new instance of the SoapDocumentMethodAttribute class.

System_CAPS_pubmethodSoapDocumentMethodAttribute(String^)

Initializes a new instance of the SoapDocumentMethodAttribute class, setting the Action property to the value of the action parameter.

NameDescription
System_CAPS_pubpropertyAction

Gets or sets the SOAPAction HTTP header field of the SOAP request.

System_CAPS_pubpropertyBinding

Gets or sets the binding an XML Web service method is implementing an operation for.

System_CAPS_pubpropertyOneWay

Gets or sets whether an XML Web service client waits for the Web server to finish processing an XML Web service method.

System_CAPS_pubpropertyParameterStyle

Gets or sets whether parameters are encapsulated within a single XML element beneath the Body element in the XML portion of a SOAP message.

System_CAPS_pubpropertyRequestElementName

Gets or sets the XML element associated with the SOAP request for an XML Web service method, which is defined in a service description as an operation.

System_CAPS_pubpropertyRequestNamespace

Gets or sets the namespace associated with the SOAP request for an XML Web service method.

System_CAPS_pubpropertyResponseElementName

Gets or sets the XML element associated with the SOAP response for an XML Web service method.

System_CAPS_pubpropertyResponseNamespace

Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyUse

Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.

NameDescription
System_CAPS_pubmethodEquals(Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object^)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP message: RPC and Document. Document refers to formatting the XML Web service method according to an XSD schema. The Document style refers to formatting the Body element as a series of one or more message parts following the Body element. Exactly how the individual message parts is determined by the Use and ParameterStyle properties. The Use property determines whether parameters are formatted Encoded or Literal. The ParameterStyle determines whether the parameters are encapsulated within a single message part following the Body element or whether each parameter is an individual message part.

For more details, see 1D777288-C0D9-4E6A-B638-F010DA031952

This attribute can be applied to both an XML Web service method on the server and a method of the proxy class on the client.

The following code example sets the message style to Document for the GetUserName XML Web service method. Additionally, the XML element with the Body element for the SOAP request and SOAP response are set to GetUserNameRequest and GetUserNameResponse, respectively.

.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