SoapDocumentMethodAttribute SoapDocumentMethodAttribute SoapDocumentMethodAttribute SoapDocumentMethodAttribute Class

Definición

Al aplicar SoapDocumentMethodAttribute a un método se especifica que los mensajes SOAP hacia y desde el método utilizan el formato 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
Herencia
SoapDocumentMethodAttributeSoapDocumentMethodAttributeSoapDocumentMethodAttributeSoapDocumentMethodAttribute
Atributos

Ejemplos

El ejemplo de código siguiente establece el estilo de mensaje en Document para el GetUserName método de servicio Web XML.The following code example sets the message style to Document for the GetUserName XML Web service method. Además, el elemento XML con el Body (elemento) para la solicitud SOAP y la respuesta SOAP se establecen en GetUserNameRequest y GetUserNameResponse, respectivamente.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

Comentarios

Lenguaje de descripción de servicios Web (WSDL) define dos estilos para dar formato a un método de servicios Web XML, que llama a una operación, en un mensaje SOAP: RPC y 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 hace referencia al formato del método de servicios Web XML según un esquema XSD.Document refers to formatting the XML Web service method according to an XSD schema. El Document estilo hace referencia al formato el Body elemento como una serie de uno o más partes del mensaje siguiendo el Body elemento.The Document style refers to formatting the Body element as a series of one or more message parts following the Body element. Exactamente cómo las partes del mensaje viene determinada por la Use y ParameterStyle propiedades.Exactly how the individual message parts is determined by the Use and ParameterStyle properties. El Use propiedad determina si los parámetros tienen el formato Encoded o Literal.The Use property determines whether parameters are formatted Encoded or Literal. El ParameterStyle determina si los parámetros se encapsulan en un siguiente parte de mensaje único el Body elemento o si cada parámetro es una parte de mensaje individual.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.

Para obtener más información, consulte personalizar el formato de mensaje SOAP.For more details, see Customizing SOAP Message Formatting.

Este atributo puede aplicarse a un método de servicios Web XML en el servidor y un método de la clase de proxy en el cliente.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.

Constructores

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

Inicializa una nueva instancia de la clase SoapDocumentMethodAttribute.Initializes a new instance of the SoapDocumentMethodAttribute class.

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

Inicializa una nueva instancia de la clase SoapDocumentMethodAttribute, estableciendo la propiedad Action en el valor del parámetro action.Initializes a new instance of the SoapDocumentMethodAttribute class, setting the Action property to the value of the action parameter.

Propiedades

Action Action Action Action

Obtiene o establece el campo de encabezado HTTP SOAPAction de la solicitud SOAP.Gets or sets the SOAPAction HTTP header field of the SOAP request.

Binding Binding Binding Binding

Obtiene o establece el enlace para el que un método de servicios Web XML está implementando una operación.Gets or sets the binding an XML Web service method is implementing an operation for.

OneWay OneWay OneWay OneWay

Obtiene o establece si un cliente de servicios Web XML debe esperar a que el servidor Web termine de procesar un método de servicios 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 ParameterStyle ParameterStyle ParameterStyle

Obtiene o establece si los parámetros se encapsulan en un único elemento XML debajo del elemento Body en la parte XML de un mensaje 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

Obtiene o establece el elemento XML asociado a la solicitud SOAP de un método de servicios Web XML, definido en una descripción de servicio como operación.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

Obtiene o establece el espacio de nombres asociado a la solicitud SOAP de un método de servicios Web XML.Gets or sets the namespace associated with the SOAP request for an XML Web service method.

ResponseElementName ResponseElementName ResponseElementName ResponseElementName

Obtiene o establece el elemento XML asociado a la respuesta SOAP de un método de servicios Web XML.Gets or sets the XML element associated with the SOAP response for an XML Web service method.

ResponseNamespace ResponseNamespace ResponseNamespace ResponseNamespace

Obtiene o establece el espacio de nombres XML asociado a la respuesta SOAP de un método de servicios Web XML.Gets or sets the XML namespace associated with the SOAP response for an XML Web service method.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Use Use Use Use

Obtiene o establece el formato de los parámetros de un método de servicios Web XML en la parte XML de un mensaje SOAP.Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.

Métodos

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

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

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

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

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

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

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

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.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)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.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()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

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

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_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)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.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)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.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)

Recupera el número de interfaces de información de tipo que proporciona un objeto (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)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: