ScriptMethodAttribute Класс

  • Ссылка

Определение

Пространство имен:
System.Web.Script.Services
Сборка:
System.Web.Extensions.dll

Задает команду 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
Наследование
Object
Attribute
ScriptMethodAttribute
Атрибуты
AttributeUsageAttribute

Примеры

В следующем примере показано, как применить ScriptMethodAttribute к GetXmlDocument методам и EchoStringAndDate , чтобы указать, какую HTTP-команду следует использовать, и указать формат ответа.

Комментарии

Этот атрибут используется для указания сведений о методах, которые можно вызывать из клиентского скрипта. Атрибут позволяет указать, какую HTTP-команду (GET или POST) можно использовать для вызова метода. Он также позволяет указать, будет ли ответ отформатирован с помощью нотации объектов JavaScript (JSON) или XML.

Атрибут ScriptMethodAttribute является необязательным. (Однако к методам, которые можно вызывать из клиентского скрипта System.Web.Services.WebMethodAttribute , должен применяться атрибут .) Если метод не помечен , ScriptMethodAttributeметод будет вызван с помощью команды HTTP POST, а ответ будет сериализован в формате JSON. Этот параметр нельзя переопределить из скрипта.

ScriptMethodAttribute принимает только именованные параметры. Ниже приведены свойства ScriptMethodAttribute класса , которые можно использовать в качестве именованных параметров:

  • UseHttpGet

    Указывает, будет ли метод вызываться с помощью команды HTTP GET. Значение по умолчанию — false.

    Важно!

    UseHttpGet Если вы работаете с конфиденциальными данными или транзакциями, для свойства true может представлять угрозу безопасности для вашего приложения. В запросах GET сообщение закодировано браузером в URL-адрес и поэтому является более простым объектом для незаконного изменения. Для запросов GET и POST следует следовать рекомендациям по безопасности для защиты конфиденциальных данных.

  • ResponseFormat

    Указывает, будет ли ответ сериализован как JSON или XML. Значение по умолчанию — Json. Свойство ResponseFormat полезно указывать XML в качестве возвращаемого типа, когда метод возвращает XmlDocument объект или XmlElement .

  • XmlSerializeString

    Указывает, сериализуются ли все возвращаемые типы, включая строковые типы, в формате 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)

Применяется к

См. также раздел