SoapDocumentMethodAttribute SoapDocumentMethodAttribute SoapDocumentMethodAttribute SoapDocumentMethodAttribute Class

Определение

Применение атрибута SoapDocumentMethodAttribute к методу указывает на то, что сообщения SOAP, посылаемые в метод и отправляемые из метода, используют форматирование Document.Applying the SoapDocumentMethodAttribute to a method specifies that SOAP messages to and from the method use Document formatting.

public ref class SoapDocumentMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)]
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class SoapDocumentMethodAttribute : Attribute
type SoapDocumentMethodAttribute = class
    inherit Attribute
Public NotInheritable Class SoapDocumentMethodAttribute
Inherits Attribute
Наследование
SoapDocumentMethodAttributeSoapDocumentMethodAttributeSoapDocumentMethodAttributeSoapDocumentMethodAttribute
Атрибуты

Примеры

В следующем примере кода для стиля Document сообщения задается значение GetUserName для метода веб-службы XML.The following code example sets the message style to Document for the GetUserName XML Web service method. Кроме того, XML-элемент с Body элементом для запроса SOAP и ответом SOAP имеет GetUserNameRequest значение и GetUserNameResponseсоответственно.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
        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

Комментарии

Язык описания веб-служб (WSDL) определяет два стиля того, как метод веб-службы XML, вызывающий операцию, может быть отформатирован в сообщении SOAP: RPC и. DocumentWeb 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относится к форматированию метода веб-службы XML в соответствии со схемой XSD.Document refers to formatting the XML Web service method according to an XSD schema. Стиль означает форматирование элемента в виде последовательности из одной или Body нескольких частей сообщения после элемента. Body DocumentThe Document style refers to formatting the Body element as a series of one or more message parts following the Body element. Точно то, как отдельные части сообщения определяются Use свойствами и. ParameterStyleExactly how the individual message parts is determined by the Use and ParameterStyle properties. Свойство определяет, форматируются Encoded ли параметры, или Literal. UseThe Use property determines whether parameters are formatted Encoded or Literal. Определяет, инкапсулируются ли параметры в одной части сообщения Body после элемента или в том, является ли каждый параметр отдельным элементом сообщения. ParameterStyleThe 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.

Дополнительные сведения см. в разделе Настройка форматирования сообщений SOAP.For more details, see Customizing SOAP Message Formatting.

Этот атрибут можно применить как к методу веб-службы XML на сервере, так и к методу прокси-класса на клиенте.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.

Конструкторы

SoapDocumentMethodAttribute() SoapDocumentMethodAttribute() SoapDocumentMethodAttribute() SoapDocumentMethodAttribute()

Инициализирует новый экземпляр класса SoapDocumentMethodAttribute.Initializes a new instance of the SoapDocumentMethodAttribute class.

SoapDocumentMethodAttribute(String) SoapDocumentMethodAttribute(String) SoapDocumentMethodAttribute(String) SoapDocumentMethodAttribute(String)

Инициализирует новый экземпляр класса SoapDocumentMethodAttribute и присваивает свойству Action значение параметра action.Initializes a new instance of the SoapDocumentMethodAttribute class, setting the Action property to the value of the action parameter.

Свойства

Action Action Action Action

Получает или задает поле HTTP-заголовка SOAPAction запроса SOAP.Gets or sets the SOAPAction HTTP header field of the SOAP request.

Binding Binding Binding Binding

Получает или задает привязку, для которой методом веб-службы XML реализуется операция.Gets or sets the binding an XML Web service method is implementing an operation for.

OneWay OneWay OneWay OneWay

Получает или задает значение, указывающее, ожидает ли клиент веб-службы XML окончания обработки веб-сервером метода веб-службы XML.Gets or sets whether an XML Web service client waits for the Web server to finish processing an XML Web service method.

ParameterStyle ParameterStyle ParameterStyle ParameterStyle

Получает или задает значение, указывающее, инкапсулируются ли параметры в одном элементе XML, следующем за элементом Body в XML-части сообщения SOAP.Gets or sets whether parameters are encapsulated within a single XML element beneath the Body element in the XML portion of a SOAP message.

RequestElementName RequestElementName RequestElementName RequestElementName

Получает или задает элемент XML, сопоставленный с запросом SOAP к методу веб-службы XML, который определяется в описании службы как операция.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.

RequestNamespace RequestNamespace RequestNamespace RequestNamespace

Получает или задает пространство имен, сопоставленное с запросом SOAP к методу веб-службы XML.Gets or sets the namespace associated with the SOAP request for an XML Web service method.

ResponseElementName ResponseElementName ResponseElementName ResponseElementName

Получает или задает элемент XML, сопоставленный с ответом SOAP для метода веб-службы XML.Gets or sets the XML element associated with the SOAP response for an XML Web service method.

ResponseNamespace ResponseNamespace ResponseNamespace ResponseNamespace

Получает или задает пространство имен XML, сопоставленное с ответом SOAP для метода веб-службы XML.Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Use Use Use Use

Получает или задает параметр форматирования метода веб-службы XML в XML-части сообщения SOAP.Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Применяется к

Дополнительно