SoapDocumentMethodAttribute Classe

Définition

Appliquer SoapDocumentMethodAttribute à une méthode spécifie que les messages SOAP en provenance et en direction de cette méthode utilisent la mise en forme 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)]
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
Héritage
SoapDocumentMethodAttribute
Attributs

Exemples

L’exemple de code suivant définit le style de message sur Document pour la GetUserName méthode de service Web XML.The following code example sets the message style to Document for the GetUserName XML Web service method. En outre, l’élément XML avec l' Body élément pour la demande SOAP et la réponse SOAP ont pour GetUserNameRequest valeur GetUserNameResponse , respectivement.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

Remarques

Web Services Description Language (WSDL) définit deux styles pour la façon dont une méthode de service Web XML, qu’elle appelle une opération, peut être mise en forme dans un message SOAP : RPC et 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 fait référence à la mise en forme de la méthode de service Web XML en fonction d’un schéma XSD.Document refers to formatting the XML Web service method according to an XSD schema. Le Document style fait référence à la mise en forme de l' Body élément sous la forme d’une série d’une ou de plusieurs parties de message après l' Body élément.The Document style refers to formatting the Body element as a series of one or more message parts following the Body element. La façon dont les différentes parties de message sont déterminées par les Use ParameterStyle Propriétés et.Exactly how the individual message parts is determined by the Use and ParameterStyle properties. La Use propriété détermine si les paramètres sont mis en forme Encoded ou Literal .The Use property determines whether parameters are formatted Encoded or Literal. ParameterStyleDétermine si les paramètres sont encapsulés dans une seule partie de message après l' Body élément ou si chaque paramètre est une partie de message individuelle.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.

Pour plus d’informations, consultez Personnalisation de la mise en forme des messages SOAP.For more details, see Customizing SOAP Message Formatting.

Cet attribut peut être appliqué à une méthode de service Web XML sur le serveur et à une méthode de la classe proxy sur le client.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.

Constructeurs

SoapDocumentMethodAttribute()

Initialise une nouvelle instance de la classe SoapDocumentMethodAttribute.Initializes a new instance of the SoapDocumentMethodAttribute class.

SoapDocumentMethodAttribute(String)

Initialise une nouvelle instance de la classe SoapDocumentMethodAttribute, affectant la valeur du paramètre action à la propriété Action.Initializes a new instance of the SoapDocumentMethodAttribute class, setting the Action property to the value of the action parameter.

Propriétés

Action

Obtient ou définit le champ d'en-tête HTTP SOAPAction de la demande SOAP.Gets or sets the SOAPAction HTTP header field of the SOAP request.

Binding

Obtient ou définit la liaison pour laquelle une méthode de service Web XML implémente une opération.Gets or sets the binding an XML Web service method is implementing an operation for.

OneWay

Obtient ou définit si le client du service Web XML attend que le serveur Web termine le traitement d'une méthode de service Web XML.Gets or sets whether an XML Web service client waits for the Web server to finish processing an XML Web service method.

ParameterStyle

Obtient ou définit si les paramètres sont encapsulés dans un seul et même élément XML sous l'élément Body, dans la portion XML d'un message 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

Obtient ou définit l'élément XML associé à la demande SOAP d'une méthode de service Web XML, qui est définie dans une description de service en tant qu'opération.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

Obtient ou définit l'espace de noms associé à la demande SOAP d'une méthode de service Web XML.Gets or sets the namespace associated with the SOAP request for an XML Web service method.

ResponseElementName

Obtient ou définit l'élément XML associé à la réponse SOAP d'une méthode de service Web XML.Gets or sets the XML element associated with the SOAP response for an XML Web service method.

ResponseNamespace

Obtient ou définit l'espace de noms XML associé à la réponse SOAP d'une méthode de service Web XML.Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)
Use

Obtient ou définit la mise en forme des paramètres d'une méthode de service Web XML dans la portion XML d'un message SOAP.Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.

Méthodes

Equals(Object)

Retourne une valeur qui indique si cette instance est égale à un objet spécifié.Returns a value that indicates whether this instance is equal to a specified object.

(Hérité de Attribute)
GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

(Hérité de Attribute)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)

S’applique à

Voir aussi