SoapDocumentMethodAttribute Class (System.Web.Services.Protocols)

Examples

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.

   <%@ WebService Language="C#" class="MyUser" %>
 using System;
 using System.Web.Services;
 using System.Web.Services.Protocols;
 public class MyUser : WebService {
       [ SoapDocumentMethod(Action="http://www.contoso.com/Sample", 
           RequestNamespace="http://www.contoso.com/Request",
           RequestElementName="GetUserNameRequest",
           ResponseNamespace="http://www.contoso.com/Response",
           ResponseElementName="GetUserNameResponse")]
      [ WebMethod(Description="Obtains the User Name") ]
      public UserName GetUserName() {
           string temp;
           int pos;
           UserName NewUser = new UserName();
           // Get the full user name, including the domain name if applicable.
           temp = User.Identity.Name;
           // Determine whether the user is part of a domain by searching for a backslash.
           pos = temp.IndexOf("\\");
           // Parse the domain name out of the string, if one exists.
           if (pos <= 0)
                 NewUser.Name = User.Identity.Name;
           else {
               NewUser.Name = temp.Remove(0,pos+1);
                 NewUser.Domain = temp.Remove(pos,temp.Length-pos);
       return NewUser;
 public class UserName {
     public string Name;
     public string Domain;
   
    <%@ WebService Language="VB" class="MyUser" %>
Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Public Class MyUser
    Inherits WebService    
    <SoapDocumentMethod(Action := "http://www.contoso.com/Sample", _
    RequestNamespace := "http://www.contoso.com/Request", _
    RequestElementName := "GetUserNameRequest", _
    ResponseNamespace := "http://www.contoso.com/Response", _
    ResponseElementName := "GetUserNameResponse"), _
    WebMethod(Description := "Obtains the User Name")> _
    Public Function GetUserName() As UserName
        Dim temp As String
        Dim pos As Integer
        Dim NewUser As New UserName()
        ' Get the full user name, including the domain name if applicable.
        temp = User.Identity.Name
        ' Determine whether the user is part of a Domain by searching for a backslash.
        pos = temp.IndexOf("\")
        ' Parse the domain name out of the string, if one exists.
        If pos <= 0 Then
            NewUser.Name = User.Identity.Name
            NewUser.Name = temp.Remove(0, pos + 1)
            NewUser.Domain = temp.Remove(pos, temp.Length - pos)
        End If
        Return NewUser
    End Function
End Class 
Public Class UserName
    Public Name As String
    Public Domain As String
End Class
    
     Remarks
    
    
     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
     
      Customizing SOAP Message Formatting
     
     .
    
    
     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.
    
    
     When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
    
    (Inherited from
    
     Attribute
    
    )
    
     When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
    
    (Inherited from
    
     Attribute
    
    )
    
     Retrieves the type information for an object, which can be used to get the type information for an interface.
    
    (Inherited from
    
     Attribute
    
    )
    
     Retrieves the number of type information interfaces that an object provides (either 0 or 1).
    
    (Inherited from
    
     Attribute
    
    )