Exportar (0) Imprimir
Expandir todo
Este artículo proviene de un motor de traducción automática. Mueva el puntero sobre las frases del artículo para ver el texto original. Más información.
Traducción
Original

ScriptMethodAttribute (Clase)

Especifica qué verbo HTTP se utiliza para invocar un método y el formato de la respuesta. Esta clase no puede heredarse.

System.Object
  System.Attribute
    System.Web.Script.Services.ScriptMethodAttribute

Espacio de nombres:  System.Web.Script.Services
Ensamblado:  System.Web.Extensions (en System.Web.Extensions.dll)

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class ScriptMethodAttribute : Attribute

El tipo ScriptMethodAttribute expone los siguientes miembros.

  NombreDescripción
Método públicoScriptMethodAttributeInicializa una nueva instancia de la clase ScriptMethodAttribute.
Arriba

  NombreDescripción
Propiedad públicaResponseFormatObtiene o establece el formato de la respuesta del método.
Propiedad públicaTypeIdCuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Se hereda de Attribute).
Propiedad públicaUseHttpGetObtiene o establece un valor que indica si se va a invocar al método utilizando HTTP GET.
Propiedad públicaXmlSerializeStringObtiene o establece un valor que indica si todos los tipos de valor devueltos se serializan como XML, lo que incluye los tipos de cadena.
Arriba

  NombreDescripción
Método públicoEqualsInfraestructura. Devuelve un valor que indica si esta instancia equivale al objeto especificado. (Se hereda de Attribute).
Método públicoGetHashCodeDevuelve el código hash de esta instancia. (Se hereda de Attribute).
Método públicoGetType Obtiene el Type de la instancia actual. (Se hereda de Object).
Método públicoIsDefaultAttributeCuando se invalida en una clase derivada, indica si el valor de esta instancia es el valor predeterminado para la clase derivada. (Se hereda de Attribute).
Método públicoMatch Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual al objeto especificado. (Se hereda de Attribute).
Método públicoToString Retorna una cadena que representa al objeto actual. (Se hereda de Object).
Arriba

  NombreDescripción
Implementación explícita de interfacesMétodo privado_Attribute.GetIDsOfNamesAsigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. (Se hereda de Attribute).
Implementación explícita de interfacesMétodo privado_Attribute.GetTypeInfoObtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. (Se hereda de Attribute).
Implementación explícita de interfacesMétodo privado_Attribute.GetTypeInfoCount

Recupera el número de interfaces de tipo de información que suministra un objeto (0 ó 1)

(Se hereda de Attribute).
Implementación explícita de interfacesMétodo privado_Attribute.InvokeProporciona acceso a las propiedades y los métodos expuestos por un objeto. (Se hereda de Attribute).
Arriba

Este atributo se utiliza para especificar información para los métodos a los que se puede llamar desde script de cliente. El atributo permite especificar qué verbo HTTP (GET o POST) se puede utilizar para invocar un método. También permite especificar si a la respuesta se le da formato JSON (JavaScript Object Notation) o XML.

El atributo ScriptMethodAttribute es opcional. (sin embargo, los métodos a los que se puede llamar desde el script de cliente deben tener aplicado el atributo System.Web.Services.WebMethodAttribute). Si un método no se marca con ScriptMethodAttribute, se llamará al método utilizando el comando HTTP POST y la respuesta se serializará como JSON. Este valor no se puede invalidar desde un script.

ScriptMethodAttribute sólo acepta parámetros con nombre. A continuación, se muestran las propiedades de la clase ScriptMethodAttribute que se pueden utilizar como parámetros con nombre:

  • UseHttpGet

    Especifica si el método se invocará utilizando el comando HTTP GET. El valor predeterminado es false.

    Nota de seguridadNota sobre la seguridad

    El establecimiento de la propiedad UseHttpGet en true podría plantear un riesgo para la seguridad de su aplicación si está trabajando con transacciones o datos confidenciales. En las solicitudes GET, el explorador codifica el mensaje en la dirección URL y, por consiguiente, su manipulación resulta más fácil. Tanto en las solicitudes GET como POST, debe seguir instrucciones de seguridad para proteger datos confidenciales.

  • ResponseFormat

    Especifica si la respuesta se va a serializar como JSON o como XML. El valor predeterminado es Json. La propiedad ResponseFormat es útil para especificar XML como tipo de valor devuelto cuando el método devuelve un objeto XmlDocument o XmlElement.

  • XmlSerializeString

    Especifica si todos los tipos de valor devueltos, incluidos los tipos de cadena, se serializan como XML. El valor de la propiedad XmlSerializeString se omite cuando la respuesta se serializa como JSON.

Para obtener más información acerca de cómo utilizar los atributos, vea Extender metadatos mediante atributos.

El ejemplo siguiente muestra cómo aplicar ScriptMethodAttribute a los métodos GetXmlDocument y EchoStringAndDate para especificar qué verbo HTTP se va a utilizar y para especificar el formato de la respuesta.


<%@ WebService Language="C#" Class="System.Web.Script.Services.CS.WebService" %>

using System;
using System.Web;
using System.Web.Services;
using System.Xml;
using System.Web.Services.Protocols;
using System.Web.Script.Services;

namespace System.Web.Script.Services.CS
{
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [ScriptService]
    public class WebService : System.Web.Services.WebService
    {

        private string _xmlString =
            @"<?xml version=""1.0"" encoding=""utf-8"" ?>
                <message>
                    <content>
                        Welcome to the asynchronous communication layer world!
                    </content>
                </message>";

        // This method returns an XmlDocument type.
        [WebMethod]
        [ScriptMethod(ResponseFormat = ResponseFormat.Xml)]
        public XmlDocument GetXmlDocument()
        {
            XmlDocument xmlDoc = new XmlDocument();
            xmlDoc.LoadXml(_xmlString);
            return xmlDoc;
        }

        // This method uses GET instead of POST.
        // For this reason its input parameters
        // are sent by the client in the
        // URL query string.
        [WebMethod]
        [ScriptMethod(UseHttpGet = true)]
        public string EchoStringAndDate(DateTime dt, string s)
        {
            return s + ":" + dt.ToString();
        }

        [WebMethod]
        public string GetServerTime()
        {

            string serverTime =
                String.Format("The current time is {0}.", DateTime.Now);

            return serverTime;

        }

        [WebMethod]
        public string Add(int a, int b)
        {

            int addition = a + b;
            string result = 
                String.Format("The addition result is {0}.", 
                    addition.ToString());

            return result;

        }

        [WebMethod]
        [ScriptMethod(ResponseFormat = ResponseFormat.Xml, 
            XmlSerializeString = true)]
        public string GetString()
        {
            return "Hello World";           
        }

    }

}


.NET Framework

Compatible con: 4.5.2, 4.5.1, 4.5, 4, 3.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (no se admite el rol Server Core), Windows Server 2008 R2 (se admite el rol Server Core con SP1 o versiones posteriores; no se admite Itanium)

.NET Framework no admite todas las versiones de todas las plataformas. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Adiciones de comunidad

AGREGAR
Mostrar:
© 2014 Microsoft