ScriptMethodAttribute Classe

Referência

Definição

Namespace:: System.Web.Script.Services

Assembly:: System.Web.Extensions.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Especifica o verbo HTTP usado para invocar um método e o formato da resposta. Essa classe não pode ser herdada.

public ref class ScriptMethodAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type ScriptMethodAttribute = class
    inherit Attribute

Public NotInheritable Class ScriptMethodAttribute
Inherits Attribute

Herança: Object

Attribute
ScriptMethodAttribute

Atributos: AttributeUsageAttribute

Exemplos

O exemplo a seguir mostra como aplicar ScriptMethodAttribute aos GetXmlDocument métodos e EchoStringAndDate para especificar qual verbo HTTP usar e especificar o formato de resposta.

Comentários

Esse atributo é usado para especificar informações para métodos que podem ser chamados do script do cliente. O atributo permite especificar qual verbo HTTP (GET ou POST) pode ser usado para invocar um método. Ele também permite especificar se a resposta é formatada usando JSON (JavaScript Object Notation) ou XML.

O atributo ScriptMethodAttribute é opcional. (No entanto, os métodos que podem ser chamados do script do cliente devem ter o System.Web.Services.WebMethodAttribute atributo aplicado.). Se um método não estiver marcado com ScriptMethodAttribute, o método será chamado usando o comando HTTP POST e a resposta será serializada como JSON. Não é possível substituir essa configuração do script.

ScriptMethodAttribute usa apenas parâmetros nomeados. Veja a seguir as propriedades da ScriptMethodAttribute classe que podem ser usadas como parâmetros nomeados:

UseHttpGet

Especifica se o método será invocado usando o comando HTTP GET. O padrão é false.

Importante

Definir a UseHttpGet propriedade como true pode representar um risco de segurança para seu aplicativo se você estiver trabalhando com dados confidenciais ou transações. Em solicitações GET, a mensagem é codificada pelo navegador na URL e, portanto, é um destino mais fácil para adulteração. Para solicitações GET e POST, você deve seguir as diretrizes de segurança para proteger dados confidenciais.
ResponseFormat

Especifica se a resposta será serializada como JSON ou como XML. O padrão é Json. A ResponseFormat propriedade é útil para especificar XML como o tipo de retorno quando o método retorna um XmlDocument objeto ou XmlElement .
XmlSerializeString

Especifica se todos os tipos de retorno, incluindo tipos de cadeia de caracteres, são serializados como XML. O valor da XmlSerializeString propriedade é ignorado quando a resposta é serializada como JSON.

Para obter mais informações sobre como usar atributos, consulte Atributos.

Construtores

ScriptMethodAttribute()

Inicializa uma nova instância da classe ScriptMethodAttribute.

Propriedades

ResponseFormat	Obtém ou define o formato da resposta do método.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
UseHttpGet	Obtém ou define um valor que indica se o método deve ser invocado usando HTTP GET.
XmlSerializeString	Obtém ou define um valor que indica se todos os tipos de retorno são serializados como XML, que inclui os tipos de cadeia de caracteres.

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição. (Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface. (Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1). (Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fornece acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute)

Aplica-se a

Partilhar via