ScriptMethodAttribute ScriptMethodAttribute ScriptMethodAttribute ScriptMethodAttribute Class

Определение

Задает команду HTTP, используемую для вызова метода и форматирования ответа.Specifies which HTTP verb is used to invoke a method, and the format of the response. Этот класс не наследуется.This class cannot be inherited.

public ref class ScriptMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class ScriptMethodAttribute : Attribute
type ScriptMethodAttribute = class
    inherit Attribute
Public NotInheritable Class ScriptMethodAttribute
Inherits Attribute
Наследование
ScriptMethodAttributeScriptMethodAttributeScriptMethodAttributeScriptMethodAttribute
Атрибуты

Примеры

В следующем примере показано, как применить ScriptMethodAttribute для GetXmlDocument и EchoStringAndDate методы, чтобы указать команду HTTP для использования и указывать формат ответа.The following example shows how to apply ScriptMethodAttribute to the GetXmlDocument and EchoStringAndDate methods to specify which HTTP verb to use and to specify the response format.

Комментарии

Этот атрибут используется для указания сведений для методов, которые могут вызываться из клиентского скрипта.This attribute is used to specify information for methods that can be called from client script. Атрибут позволяет указать, какие команды HTTP (GET или POST) можно использовать для вызова метода.The attribute lets you specify which HTTP verb (GET or POST) can be used to invoke a method. Это также позволяет указать, будет ли ответ форматируется с помощью нотации объектов JavaScript (JSON) или XML.It also lets you specify whether the response is formatted by using either JavaScript Object Notation (JSON) or XML.

Атрибут ScriptMethodAttribute является необязательным.The ScriptMethodAttribute attribute is optional. (Тем не менее, должен иметь методы, которые могут вызываться из клиентского сценария System.Web.Services.WebMethodAttribute применен атрибут.).(However, methods that can be called from client script must have the System.Web.Services.WebMethodAttribute attribute applied.). Если метод не помечен атрибутом ScriptMethodAttribute, метод будет вызываться с помощью команды HTTP POST и ответ должен быть сериализован как JSON.If a method is not marked with ScriptMethodAttribute, the method will be called by using the HTTP POST command and the response will be serialized as JSON. Не может переопределить этот параметр из скрипта.You cannot override this setting from script.

ScriptMethodAttribute принимает только именованные параметры.ScriptMethodAttribute takes only named parameters. Ниже приведены свойства ScriptMethodAttribute класс, который может использоваться как именованные параметры:The following are the properties of the ScriptMethodAttribute class that can be used as named parameters:

  • UseHttpGet

    Указывает, является ли метод будет вызываться с помощью команды HTTP GET.Specifies whether the method will be invoked by using the HTTP GET command. Значение по умолчанию — false.The default is false.

    Важно!

    Установка UseHttpGet свойства true может представлять угрозу безопасности для вашего приложения, если вы работаете с конфиденциальных данных или транзакций.Setting the UseHttpGet property to true might pose a security risk for your application if you are working with sensitive data or transactions. В запросах GET сообщение кодируется с помощью браузера в URL-адрес и поэтому легкой целью для незаконного изменения.In GET requests, the message is encoded by the browser into the URL and is therefore an easier target for tampering. Для запросов GET и POST следует придерживаться рекомендаций по безопасности для защиты конфиденциальных данных.For both GET and POST requests, you should follow security guidelines to protect sensitive data.

  • ResponseFormat

    Указывает, будет ли сериализован ответ JSON или XML.Specifies whether the response will be serialized as JSON or as XML. Значение по умолчанию — Json.The default is Json. ResponseFormat Свойство полезно для указания XML как тип возвращаемого значения, возвращаемое методом XmlDocument или XmlElement объекта.The ResponseFormat property is useful to specify XML as the return type when the method returns an XmlDocument or an XmlElement object.

  • XmlSerializeString

    Указывает, является ли все возвращаемые типы, включая строковые, сериализуются в формат XML.Specifies whether all return types, including string types, are serialized as XML. Значение XmlSerializeString свойство учитывается, если ответ является сериализованным в JSON.The value of the XmlSerializeString property is ignored when the response is serialized as JSON.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about how to use attributes, see Attributes.

Конструкторы

ScriptMethodAttribute() ScriptMethodAttribute() ScriptMethodAttribute() ScriptMethodAttribute()

Инициализирует новый экземпляр класса ScriptMethodAttribute.Initializes a new instance of the ScriptMethodAttribute class.

Свойства

ResponseFormat ResponseFormat ResponseFormat ResponseFormat

Возвращает или задает формат ответа метода.Gets or sets the format of the method response.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
UseHttpGet UseHttpGet UseHttpGet UseHttpGet

Возвращает или задает значение, позволяющее определить, следует ли вызывать метод с помощью команды HTTP GET.Gets or sets a value that indicates whether to invoke the method by using HTTP GET.

XmlSerializeString XmlSerializeString XmlSerializeString XmlSerializeString

Возвращает или задает значение, указывающее, будут ли все возвращаемые типы, включая строковые, сериализованы в формат XML.Gets or sets a value that indicates whether all return types are serialized as XML, which includes string types.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

При переопределении в производном классе показывает, является ли значение данного экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

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

Дополнительно