ScriptMethodAttribute ScriptMethodAttribute ScriptMethodAttribute ScriptMethodAttribute Class

Definición

Especifica qué verbo HTTP se utiliza para invocar un método y el formato de la respuesta.Specifies which HTTP verb is used to invoke a method, and the format of the response. Esta clase no puede heredarse.This class cannot be inherited.

public ref class ScriptMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class ScriptMethodAttribute : Attribute
type ScriptMethodAttribute = class
    inherit Attribute
Public NotInheritable Class ScriptMethodAttribute
Inherits Attribute
Herencia
ScriptMethodAttributeScriptMethodAttributeScriptMethodAttributeScriptMethodAttribute
Atributos

Ejemplos

El ejemplo siguiente muestra cómo aplicar ScriptMethodAttribute a la GetXmlDocument y EchoStringAndDate métodos para especificar qué verbo HTTP para usar y para especificar el formato de respuesta.The following example shows how to apply ScriptMethodAttribute to the GetXmlDocument and EchoStringAndDate methods to specify which HTTP verb to use and to specify the response format.

Comentarios

Este atributo se utiliza para especificar información para los métodos que se puede llamar desde script de cliente.This attribute is used to specify information for methods that can be called from client script. El atributo permite especificar qué verbo HTTP (GET o POST) puede usarse para invocar un método.The attribute lets you specify which HTTP verb (GET or POST) can be used to invoke a method. También permite especificar si se da formato a la respuesta mediante el uso de JavaScript Object Notation (JSON) o XML.It also lets you specify whether the response is formatted by using either JavaScript Object Notation (JSON) or XML.

El atributo ScriptMethodAttribute es opcional.The ScriptMethodAttribute attribute is optional. (Sin embargo, los métodos que se pueden llamar desde script de cliente deben tener el System.Web.Services.WebMethodAttribute atributo aplicado.).(However, methods that can be called from client script must have the System.Web.Services.WebMethodAttribute attribute applied.). Si un método no está marcado con ScriptMethodAttribute, se llamará al método mediante el comando HTTP POST y la respuesta será serializada como JSON.If a method is not marked with ScriptMethodAttribute, the method will be called by using the HTTP POST command and the response will be serialized as JSON. No se puede invalidar esta configuración de la secuencia de comandos.You cannot override this setting from script.

ScriptMethodAttribute toma sólo con el nombre de los parámetros.ScriptMethodAttribute takes only named parameters. Los siguientes son las propiedades de la ScriptMethodAttribute clase que se puede usar como parámetros con nombre:The following are the properties of the ScriptMethodAttribute class that can be used as named parameters:

  • UseHttpGet

    Especifica si se invocará el método mediante el comando HTTP GET.Specifies whether the method will be invoked by using the HTTP GET command. De manera predeterminada, es false.The default is false.

    Importante

    Establecer el UseHttpGet propiedad true podría suponer un riesgo de seguridad para la aplicación si está trabajando con datos confidenciales o transacciones.Setting the UseHttpGet property to true might pose a security risk for your application if you are working with sensitive data or transactions. En las solicitudes GET, el mensaje se codifica mediante el explorador en la dirección URL y, por tanto, es un objetivo más fácil su manipulación.In GET requests, the message is encoded by the browser into the URL and is therefore an easier target for tampering. Para las solicitudes GET y POST, debe seguir las directrices de seguridad para proteger los datos confidenciales.For both GET and POST requests, you should follow security guidelines to protect sensitive data.

  • ResponseFormat

    Especifica si la respuesta será serializada como JSON o como XML.Specifies whether the response will be serialized as JSON or as XML. De manera predeterminada, es Json.The default is Json. El ResponseFormat propiedad es útil para especificar el XML como tipo de valor devuelto cuando el método devuelve un XmlDocument o un XmlElement objeto.The ResponseFormat property is useful to specify XML as the return type when the method returns an XmlDocument or an XmlElement object.

  • XmlSerializeString

    Especifica si todos los tipos de valor devuelto, incluidos los tipos de cadena, se serializan como XML.Specifies whether all return types, including string types, are serialized as XML. El valor de la XmlSerializeString propiedad se omite cuando la respuesta se serializa como JSON.The value of the XmlSerializeString property is ignored when the response is serialized as JSON.

Para obtener más información acerca de cómo utilizar los atributos, vea atributos.For more information about how to use attributes, see Attributes.

Constructores

ScriptMethodAttribute() ScriptMethodAttribute() ScriptMethodAttribute() ScriptMethodAttribute()

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

Propiedades

ResponseFormat ResponseFormat ResponseFormat ResponseFormat

Obtiene o establece el formato de la respuesta del método.Gets or sets the format of the method response.

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

Obtiene o establece un valor que indica si se va a invocar al método utilizando HTTP GET.Gets or sets a value that indicates whether to invoke the method by using HTTP GET.

XmlSerializeString XmlSerializeString XmlSerializeString XmlSerializeString

Obtiene o establece un valor que indica si todos los tipos de valor devueltos se serializan como XML, lo que incluye los tipos de cadena.Gets or sets a value that indicates whether all return types are serialized as XML, which includes string types.

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: