Export (0) Print
Expand All

SoapDocumentMethodAttribute.Use Property

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

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

public SoapBindingUse Use { get; set; }

Property Value

Type: System.Web.Services.Description.SoapBindingUse
The SoapBindingUse for the XML Web service method. The default is Literal.

The Web Services Description Language (WSDL) defines two methods for formatting parameters: Encoded and Literal. Encoded refers to formatting parameters using SOAP encoding, as outlined in the SOAP specification in section 5. Literal refers to formatting the parameters using a pre-defined XSD schema for each parameter.

For more details, see [<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>].

The following code example specifies that Document / Encoded SOAP messages must be sent to the PlaceOrder XML Web service method.

<%@ WebService Language="C#" Class="ShoppingCart" %>

 using System.Web.Services;
 using System.Web.Services.Protocols;
 using System.Web.Services.Description;
 using System;

 public class ShoppingCart 
 {
       [ SoapDocumentMethod(Use=SoapBindingUse.Encoded) ]
       [ WebMethod]
       public void PlaceOrder(OrderItem O) 
       {
        // Process the order on the back end.
       }      
 }

public class OrderItem
{
  public int Count;
  public int Description;
  public DateTime OrderDate;
  public long CustomerID;
  public Decimal Cost;
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft