ScriptMethodAttribute Classe

Référence

Définition

Espace de noms:: System.Web.Script.Services

Assembly:: System.Web.Extensions.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Spécifie le verbe HTTP utilisé pour appeler une méthode, ainsi que le format de la réponse. Cette classe ne peut pas être héritée.

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

Héritage: Object

Attribute
ScriptMethodAttribute

Attributs: AttributeUsageAttribute

Exemples

L’exemple suivant montre comment appliquer ScriptMethodAttribute aux méthodes et EchoStringAndDate pour spécifier le GetXmlDocument verbe HTTP à utiliser et pour spécifier le format de réponse.

Remarques

Cet attribut est utilisé pour spécifier des informations pour les méthodes qui peuvent être appelées à partir du script client. L’attribut vous permet de spécifier le verbe HTTP (GET ou POST) qui peut être utilisé pour appeler une méthode. Il vous permet également de spécifier si la réponse est mise en forme à l’aide de JSON (JavaScript Object Notation) ou de XML.

L'attribut ScriptMethodAttribute est facultatif. (Toutefois, l’attribut System.Web.Services.WebMethodAttribute doit être appliqué aux méthodes qui peuvent être appelées à partir du script client.). Si une méthode n’est pas marquée avec ScriptMethodAttribute, la méthode est appelée à l’aide de la commande HTTP POST et la réponse est sérialisée au format JSON. Vous ne pouvez pas remplacer ce paramètre à partir d’un script.

ScriptMethodAttribute prend uniquement les paramètres nommés. Voici les propriétés de la ScriptMethodAttribute classe qui peuvent être utilisées comme paramètres nommés :

UseHttpGet

Spécifie si la méthode sera appelée à l’aide de la commande HTTP GET. La valeur par défaut est false.

Important

La définition de la UseHttpGet propriété sur true peut présenter un risque de sécurité pour votre application si vous utilisez des données ou des transactions sensibles. Dans les requêtes GET, le message est encodé par le navigateur dans l’URL et constitue donc une cible plus facile à falsifier. Pour les demandes GET et POST, vous devez suivre les instructions de sécurité pour protéger les données sensibles.
ResponseFormat

Spécifie si la réponse sera sérialisée au format JSON ou XML. La valeur par défaut est Json. La ResponseFormat propriété est utile pour spécifier XML comme type de retour lorsque la méthode retourne un XmlDocument objet ou un XmlElement objet .
XmlSerializeString

Spécifie si tous les types de retour, y compris les types de chaîne, sont sérialisés au format XML. La valeur de la XmlSerializeString propriété est ignorée lorsque la réponse est sérialisée au format JSON.

Pour plus d’informations sur l’utilisation des attributs, consultez Attributs.

Constructeurs

ScriptMethodAttribute()

Initialise une nouvelle instance de la classe ScriptMethodAttribute.

Propriétés

ResponseFormat	Obtient ou définit le format de la réponse de méthode.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)
UseHttpGet	Obtient ou définit une valeur qui indique si la méthode doit être appelée à l'aide de la commande HTTP GET.
XmlSerializeString	Obtient ou définit une valeur qui indique si tous les types de retour, y compris les types chaîne, sont sérialisés au format XML.

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (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. (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é. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (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. (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. (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). (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. (Hérité de Attribute)

S’applique à

Partager via