ScriptMethodAttribute Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Указывает, какая http-команда используется для вызова метода и формата ответа. Этот класс не может быть унаследован.
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
- Наследование
- Атрибуты
Примеры
В следующем примере показано, как применяться ScriptMethodAttribute к GetXmlDocument и EchoStringAndDate методам, чтобы указать, какую http-команду следует использовать и указать формат ответа.
Комментарии
Этот атрибут используется для указания сведений о методах, которые могут вызываться из клиентского скрипта. Атрибут позволяет указать, какую команду HTTP (GET или POST) можно использовать для вызова метода. Кроме того, можно указать, форматируется ли ответ с помощью нотации объектов JavaScript (JSON) или XML.
Атрибут ScriptMethodAttribute необязателен. (Однако методы, которые можно вызывать из клиентского System.Web.Services.WebMethodAttribute скрипта, должны иметь примененный атрибут.). Если метод не помечен, ScriptMethodAttributeметод будет вызываться с помощью команды HTTP POST, а ответ сериализуется в формате JSON. Этот параметр нельзя переопределить из скрипта.
ScriptMethodAttribute принимает только именованные параметры. Ниже приведены свойства ScriptMethodAttribute класса, который можно использовать в качестве именованных параметров:
-
Указывает, будет ли метод вызываться с помощью команды HTTP GET. Значение по умолчанию —
false.Это важно
UseHttpGet Если вы работаете с конфиденциальными данными или транзакциями, свойство
trueможет представлять угрозу безопасности для приложения. В запросах GET сообщение закодировано браузером в URL-адрес и поэтому проще для изменения. Для запросов GET и POST следует следовать рекомендациям по безопасности для защиты конфиденциальных данных. -
Указывает, сериализуется ли ответ в формате JSON или в формате XML. Значение по умолчанию —
Json. Свойство ResponseFormat полезно указать XML в качестве возвращаемого XmlDocumentXmlElement типа, когда метод возвращает объект или объект. -
Указывает, сериализуются ли все типы возвращаемых данных, включая типы строк, в формате XML. Значение XmlSerializeString свойства игнорируется при сериализации ответа в формате JSON.
Дополнительные сведения об использовании атрибутов см. в разделе "Атрибуты".
Конструкторы
| Имя | Описание |
|---|---|
| ScriptMethodAttribute() |
Инициализирует новый экземпляр класса ScriptMethodAttribute. |
Свойства
| Имя | Описание |
|---|---|
| ResponseFormat |
Возвращает или задает формат ответа метода. |
| TypeId |
При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute) |
| UseHttpGet |
Возвращает или задает значение, указывающее, следует ли вызывать метод с помощью HTTP GET. |
| XmlSerializeString |
Возвращает или задает значение, указывающее, сериализуются ли все типы возвращаемых значений в формате XML, включая типы строк. |
Методы
| Имя | Описание |
|---|---|
| Equals(Object) |
Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute) |
| GetHashCode() |
Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| IsDefaultAttribute() |
При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute) |
| Match(Object) |
При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Явные реализации интерфейса
| Имя | Описание |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute) |