SoapDocumentMethodAttribute 类

定义

命名空间:

System.Web.Services.Protocols

程序集:

System.Web.Services.dll

对方法应用 SoapDocumentMethodAttribute 将指定发往该方法以及来自该方法的 SOAP 消息使用 Document 格式设置。

public ref class SoapDocumentMethodAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class SoapDocumentMethodAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type SoapDocumentMethodAttribute = class
    inherit Attribute

Public NotInheritable Class SoapDocumentMethodAttribute
Inherits Attribute

继承

Object

Attribute

SoapDocumentMethodAttribute

属性

AttributeUsageAttribute

示例

下面的代码示例将 GetUserName XML Web 服务方法的消息样式设置为 Document 。 此外，具有 Body SOAP 请求和 SOAP 响应元素的 XML 元素分别设置为 GetUserNameRequest 和 GetUserNameResponse。

<%@ 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
        Else
            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

注解

Web 服务描述语言 (WSDL) 定义了两种样式，它调用操作的 XML Web 服务方法可以在 SOAP 消息中设置格式： RPC 和 Document。 Document 是指根据 XSD 架构设置 XML Web 服务方法的格式。 样式 Document 是指将 Body 元素的格式设置为元素后面的 Body 一个或多个消息部分的一系列。 各个消息部分的确切方式由 Use 和 ParameterStyle 属性确定。 属性Use确定参数是格式化EncodedLiteral的还是 。 确定 ParameterStyle 参数是封装在 元素后面的 Body 单个消息部分中，还是每个参数都是单个消息部分。

有关更多详细信息，请参阅 自定义 SOAP 消息格式。

此属性可以应用于服务器上的 XML Web 服务方法和客户端上的代理类的方法。

构造函数

SoapDocumentMethodAttribute()	初始化 SoapDocumentMethodAttribute 类的新实例。
SoapDocumentMethodAttribute(String)	初始化 SoapDocumentMethodAttribute 类的新实例，并将 Action 属性设置为 action 参数的值。

属性

Action	获取或设置 SOAP 请求的 SOAPActionHTTP 标头字段。
Binding	获取或设置 XML Web services 方法正在为其实现操作的绑定。
OneWay	获取或设置 XML Web services 客户端是否等待 Web 服务器完成对 XML Web services 方法的处理。
ParameterStyle	获取或设置参数是否封装在 SOAP 消息的 XML 部分中 Body 元素下的单个 XML 元素中。
RequestElementName	获取或设置与 XML Web services 方法的 SOAP 请求相关联的 XML 元素，该元素在服务说明中定义为了一个操作。
RequestNamespace	获取或设置与 XML Web services 方法的 SOAP 请求关联的命名空间。
ResponseElementName	获取或设置与 XML Web services 方法的 SOAP 响应关联的 XML 元素。
ResponseNamespace	获取或设置与 XML Web services 方法的 SOAP 响应关联的 XML 命名空间。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)
Use	获取或设置 SOAP 消息的 XML 部分中的 XML Web services 方法的参数格式设置。

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	将一组名称映射为对应的一组调度标识符。 (继承自 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	检索对象的类型信息，然后可以使用该信息获取接口的类型信息。 (继承自 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	检索对象提供的类型信息接口的数量（0 或 1）。 (继承自 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	提供对某一对象公开的属性和方法的访问。 (继承自 Attribute)

另请参阅

• SoapDocumentServiceAttribute
• SoapRpcMethodAttribute
• SoapRpcServiceAttribute
• SoapBindingUse
• SoapParameterStyle