ScriptMethodAttribute Classe
Définition
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 et 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 AttributePublic NotInheritable Class ScriptMethodAttribute
Inherits Attribute- Héritage
- Attributs
Exemples
L’exemple suivant montre comment s’appliquer ScriptMethodAttribute aux GetXmlDocument méthodes et EchoStringAndDate aux méthodes pour spécifier le 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 JAVAScript Object Notation (JSON) ou XML.
L'attribut ScriptMethodAttribute est facultatif. (Toutefois, les méthodes qui peuvent être appelées à partir du script client doivent avoir l’attribut System.Web.Services.WebMethodAttribute appliqué.). 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 en tant que JSON. Vous ne pouvez pas remplacer ce paramètre à partir du 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 :
-
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é
truepeut présenter un risque de sécurité pour votre application si vous utilisez des données sensibles ou des transactions. Dans les requêtes GET, le message est encodé par le navigateur dans l’URL et est donc une cible plus facile à falsifier. Pour les requêtes GET et POST, vous devez suivre les instructions de sécurité pour protéger les données sensibles. -
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 du code XML comme type de retour lorsque la méthode retourne un XmlDocument ou un XmlElement objet. -
Spécifie si tous les types de retour, y compris les types de chaînes, sont sérialisés en tant que XML. La valeur de la XmlSerializeString propriété est ignorée lorsque la réponse est sérialisée en tant que JSON.
Pour plus d’informations sur l’utilisation des attributs, consultez Attributs.
Constructeurs
| Nom | Description |
|---|---|
| ScriptMethodAttribute() |
Initialise une nouvelle instance de la classe ScriptMethodAttribute. |
Propriétés
| Nom | Description |
|---|---|
| ResponseFormat |
Obtient ou définit le format de la réponse de la méthode. |
| TypeId |
En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute) |
| UseHttpGet |
Obtient ou définit une valeur qui indique s’il faut appeler la méthode à l’aide de HTTP GET. |
| XmlSerializeString |
Obtient ou définit une valeur qui indique si tous les types de retour sont sérialisés en tant que XML, qui inclut des types de chaînes. |
Méthodes
| Nom | Description |
|---|---|
| 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 pour cette instance. (Hérité de Attribute) |
| GetType() |
Obtient la 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 de la classe dérivée. (Hérité de Attribute) |
| Match(Object) |
En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute) |
| MemberwiseClone() |
Crée une copie superficielle du Objectactuel. (Hérité de Object) |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Object) |
Implémentations d’interfaces explicites
| Nom | Description |
|---|---|
| _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 d’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 méthodes exposées par un objet. (Hérité de Attribute) |
