通过

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

示例

以下示例演示如何将 GetXmlDocument 应用于 ScriptMethodAttribute 和 EchoStringAndDate 方法，以指定要使用的 HTTP 谓词并指定响应格式。

注解

此属性用于指定可从客户端脚本调用的方法的信息。 通过 特性，可以指定哪个 HTTP 谓词 (GET 或 POST) 可用于调用方法。 它还允许你指定是使用 JavaScript 对象表示法 (JSON) 还是 XML 设置响应的格式。

ScriptMethodAttribute 属性是可选项。 (但是，可从客户端脚本调用的方法必须具有 System.Web.Services.WebMethodAttribute applied.) 特性。 如果方法未标记为 ScriptMethodAttribute，则将使用 HTTP POST 命令调用该方法，并且响应将序列化为 JSON。 无法从脚本替代此设置。

ScriptMethodAttribute 仅采用命名参数。 以下是可用作命名参数的 ScriptMethodAttribute 类的属性：

  • UseHttpGet

    指定是否将使用 HTTP GET 命令调用 方法。 默认值为 false。

    重要

    如果使用的是敏感数据或事务， UseHttpGet 将 属性设置为 true 可能会给应用程序带来安全风险。 在 GET 请求中，浏览器将消息编码为 URL，因此更容易被篡改。 对于 GET 和 POST 请求，应遵循安全准则来保护敏感数据。

  • ResponseFormat

    指定是将响应序列化为 JSON 还是 XML。 默认值为 Json。 当方法返回 XmlDocument 或 XmlElement 对象时，属性ResponseFormat可用于将 XML 指定为返回类型。

  • XmlSerializeString

    指定是否将所有返回类型（包括字符串类型）序列化为 XML。 当响应序列化为 JSON 时，将忽略 属性的值 XmlSerializeString 。

有关如何使用属性的详细信息，请参阅 特性。

构造函数

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)

适用于

另请参阅