SoapDocumentMethodAttribute Klasse

Definition

Durch die Anwendung von SoapDocumentMethodAttribute auf eine Methode wird angegeben, dass SOAP-Nachrichten an die bzw. von der Methode die Document-Formatierung verwenden.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)]
public sealed class SoapDocumentMethodAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)]
public sealed class SoapDocumentMethodAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Method)>]
type SoapDocumentMethodAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)>]
type SoapDocumentMethodAttribute = class
    inherit Attribute
Public NotInheritable Class SoapDocumentMethodAttribute
Inherits Attribute
Vererbung
SoapDocumentMethodAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird der Nachrichten Stil Document für die GetUserName XML-Webdienst Methode auf festgelegt.The following code example sets the message style to Document for the GetUserName XML Web service method. Darüber hinaus wird das XML-Element mit der Body für die SOAP-Anforderung und die SOAP-Antwort sind-Elementgruppe GetUserNameRequest und GetUserNameResponsebzw.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

Hinweise

In Web Services Description Language (WSDL) werden zwei Stile definiert, wie eine XML-Webdienst Methode, die einen Vorgang aufruft, in einer SOAP-Nachricht formatiert werden kann: RPC und Document .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 bezieht sich auf das Formatieren der XML-Webdienst Methode gemäß einem XSD-Schema.Document refers to formatting the XML Web service method according to an XSD schema. Der Document Stil bezieht sich auf das Body Formatieren des Elements als eine Reihe von mindestens einem Nachrichten Teil, der auf das Body Element folgt.The Document style refers to formatting the Body element as a series of one or more message parts following the Body element. Genau, wie die einzelnen Nachrichten Teile von der-Eigenschaft und der-Eigenschaft bestimmt werden Use ParameterStyle .Exactly how the individual message parts is determined by the Use and ParameterStyle properties. Die- Use Eigenschaft bestimmt, ob Parameter oder formatiert sind Encoded Literal .The Use property determines whether parameters are formatted Encoded or Literal. ParameterStyleBestimmt, ob die Parameter innerhalb eines einzelnen Nachrichten Teils gekapselt werden, der dem Element folgt, Body oder ob jeder Parameter ein einzelner Nachrichten Teil ist.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.

Weitere Informationen finden Sie unter Anpassen der Formatierung von SOAP-Nachrichten.For more details, see Customizing SOAP Message Formatting.

Dieses Attribut kann sowohl auf eine XML-Webdienst Methode auf dem Server als auch auf eine Methode der Proxy Klasse auf dem Client angewendet werden.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.

Konstruktoren

SoapDocumentMethodAttribute()

Initialisiert eine neue Instanz der SoapDocumentMethodAttribute-Klasse.Initializes a new instance of the SoapDocumentMethodAttribute class.

SoapDocumentMethodAttribute(String)

Initialisiert eine neue Instanz der SoapDocumentMethodAttribute-Klasse und legt die Action-Eigenschaft auf den Wert des action-Parameters fest.Initializes a new instance of the SoapDocumentMethodAttribute class, setting the Action property to the value of the action parameter.

Eigenschaften

Action

Ruft das SOAPAction-HTTP-Headerfeld der SOAP-Anforderung ab oder legt dieses fest.Gets or sets the SOAPAction HTTP header field of the SOAP request.

Binding

Ruft den Namen einer Bindung ab, für die eine XML-Webdienstmethode einen Vorgang implementiert, oder legt diesen fest.Gets or sets the binding an XML Web service method is implementing an operation for.

OneWay

Ruft ab oder legt fest, ob ein XML-Webdienstclient darauf wartet, dass der Webserver die Verarbeitung einer XML-Webdienstmethode beendet.Gets or sets whether an XML Web service client waits for the Web server to finish processing an XML Web service method.

ParameterStyle

Ruft ab oder legt fest, ob Parameter innerhalb eines einzelnen XML-Elements unterhalb des Body-Elements im XML-Teil einer SOAP-Nachricht gekapselt sind.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

Ruft das XML-Element ab, das der SOAP-Anforderung für eine XML-Webdienstmethode zugeordnet ist, die in einer Dienstbeschreibung als Vorgang definiert ist, oder legt dieses fest.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

Ruft den Namespace ab, der der SOAP-Anforderung für eine XML-Webdienstmethode zugeordnet ist, oder legt diesen fest.Gets or sets the namespace associated with the SOAP request for an XML Web service method.

ResponseElementName

Ruft das XML-Element ab, das der SOAP-Antwort für eine XML-Webdienstmethode zugeordnet ist, oder legt dieses fest.Gets or sets the XML element associated with the SOAP response for an XML Web service method.

ResponseNamespace

Ruft den XML-Namespace ab, der der SOAP-Antwort für eine XML-Webdienstmethode zugeordnet ist, oder legt diesen fest.Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
Use

Ruft die Parameterformatierung für eine XML-Webdienstmethode innerhalb des XML-Teils einer SOAP-Nachricht ab oder legt diese fest.Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Weitere Informationen