284 lines
19 KiB
XML
284 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="SoapDocumentMethodAttribute" FullName="System.Web.Services.Protocols.SoapDocumentMethodAttribute">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class SoapDocumentMethodAttribute : Attribute" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web.Services</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Attribute</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>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 <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Use" /> and <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ParameterStyle" /> properties. The <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Use" /> property determines whether parameters are formatted Encoded or Literal. The <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.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.</para>
|
|
<para>For more details, see <format type="text/html"><a href="1D777288-C0D9-4E6A-B638-F010DA031952">[<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>]</a></format> </para>
|
|
<para>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.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Applying the <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> to a method specifies that SOAP messages to and from the method use Document formatting.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapDocumentMethodAttribute ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapDocumentMethodAttribute (string action);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="action" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> class, setting the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> property to the value of the <paramref name="action" /> parameter.</para>
|
|
</summary>
|
|
<param name="action">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The SOAPAction HTTP header field of the SOAP request. Sets the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> property. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Action">
|
|
<MemberSignature Language="C#" Value="public string Action { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Typically, the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> property is a URI indicating the intent of the request. However, the SOAP specification places no restrictions on the format of the URI, or any rules about whether the URI is resolvable. The presence and content of the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> property can be used by Web servers, such as firewalls, to appropriately filter SOAP request messages in HTTP.</para>
|
|
<para>By default, the .NET Framework version 1.1 publishes the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> property in the soapAction attribute of the soap:operation element for each supported SOAP binding in WSDL documents generated for an XML Web service. For more information on the SOAP specification, see the W3C Web site (http://www.w3.org/TR/SOAP).</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the SOAPAction HTTP header field of the SOAP request.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Binding">
|
|
<MemberSignature Language="C#" Value="public string Binding { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A binding, as defined by Web Services Description Language (WSDL), is similar to an interface in that it defines a concrete set of operations. With respect to XML Web services created using ASP.NET, each XML Web service method is an operation within a binding. XML Web service methods are members of either the default binding for an XML Web service or a binding specified within a <see cref="T:System.Web.Services.WebServiceBindingAttribute" /> applied to an XML Web service. An XML Web service can implement multiple bindings when multiple <see cref="T:System.Web.Services.WebServiceBindingAttribute" /> attributes are applied to an XML Web service.</para>
|
|
<para>Once one or more <see cref="T:System.Web.Services.WebServiceBindingAttribute" /> attributes are applied to an XML Web service, a <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> can be applied to individual XML Web service methods to indicate the binding operation implemented by a particular XML Web service method. Set the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Binding" /> property of <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> to specify the binding an XML Web service method is implementing an operation for. Only one <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> can be applied to an XML Web service method. Therefore, an XML Web service method can only implement an operation for one binding.</para>
|
|
<para>For more information on the WSDL specification, see the W3C Web site (http://www.w3.org/TR/wsdl).</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the binding an XML Web service method is implementing an operation for.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OneWay">
|
|
<MemberSignature Language="C#" Value="public bool OneWay { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'bool'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When an XML Web service method has the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay" /> property set to true, the XML Web service client does not have to wait for the Web server to finish processing the XML Web service method. As soon as the Web server has deserialized the <see cref="T:System.Web.Services.Protocols.SoapServerMessage" />, but before invoking the XML Web service method, the server returns an HTTP 202 status code. A HTTP 202 status code indicates to the client that the Web server has started processing the message. Therefore, an XML Web service client receives no acknowledgment that the Web server successfully processed the message.</para>
|
|
<para>One-way methods cannot have a return value or any out parameters.</para>
|
|
<para>If you are using the .NET Framework version 1.0 XML Web service methods that have either the <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> attribute applied to them with the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay" /> property of set to true, do not have access to their <see cref="T:System.Web.HttpContext" /> using the static <see cref="P:System.Web.HttpContext.Current" /> property. To access the <see cref="T:System.Web.HttpContext" />, derive the class implementing the XML Web service method from <see cref="T:System.Web.Services.WebService" /> and access the <see cref="P:System.Web.Services.WebService.Context" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets whether an XML Web service client waits for the Web server to finish processing an XML Web service method.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ParameterStyle">
|
|
<MemberSignature Language="C#" Value="public System.Web.Services.Protocols.SoapParameterStyle ParameterStyle { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.Services.Protocols.SoapParameterStyle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'SoapParameterStyle'</value>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets whether parameters are encapsulated within a single XML element beneath the Body element in the XML portion of a SOAP message.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RequestElementName">
|
|
<MemberSignature Language="C#" Value="public string RequestElementName { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.RequestElementName" /> defines the XML element used to wrap the parameters beneath the Body element of the SOAP request when <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ParameterStyle" /> is <see cref="F:System.Web.Services.Protocols.SoapParameterStyle.Wrapped" />. This is reflected in the XSD schema representing the SOAP request to the XML Web service method within the service description for an XML Web service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>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.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RequestNamespace">
|
|
<MemberSignature Language="C#" Value="public string RequestNamespace { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>
|
|
<see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.RequestNamespace" /> is used in the XSD schema for the XML Web service method within its service description.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the namespace associated with the SOAP request for an XML Web service method.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ResponseElementName">
|
|
<MemberSignature Language="C#" Value="public string ResponseElementName { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ResponseElementName" /> defines the XML element used to wrap the parameters beneath the Body element of the SOAP response when <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ParameterStyle" /> is <see cref="F:System.Web.Services.Protocols.SoapParameterStyle.Wrapped" />. This is reflected in the XSD schema representing the SOAP response to the XML Web service method within the XML Web service's service description.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the XML element associated with the SOAP response for an XML Web service method.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ResponseNamespace">
|
|
<MemberSignature Language="C#" Value="public string ResponseNamespace { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ResponseNamespace" /> property is used in the XSD schema for the XML Web service method in its service description.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Use">
|
|
<MemberSignature Language="C#" Value="public System.Web.Services.Description.SoapBindingUse Use { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.Services.Description.SoapBindingUse</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.Web.Services.Description.SoapBindingUse" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The Web Services Description Language (WSDL) defines two methods for formatting parameters: <see cref="F:System.Web.Services.Description.SoapBindingUse.Encoded" /> and <see cref="F:System.Web.Services.Description.SoapBindingUse.Literal" />. <see cref="F:System.Web.Services.Description.SoapBindingUse.Encoded" /> refers to formatting parameters using SOAP encoding, as outlined in the SOAP specification in section 5. <see cref="F:System.Web.Services.Description.SoapBindingUse.Literal" /> refers to formatting the parameters using a pre-defined XSD schema for each parameter.</para>
|
|
<para>For more details, see <format type="text/html"><a href="1D777288-C0D9-4E6A-B638-F010DA031952">[<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>]</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |