ScriptMethodAttribute クラス

定義

メソッドの呼び出しに使用する 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
継承
ScriptMethodAttribute
属性

次の例では、ScriptMethodAttributeGetXmlDocument および 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 Object Notation (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 プロパティは、メソッドが XmlDocument または XmlElement オブジェクトを返す場合に、戻り値の型として XML を指定する場合に便利です。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. 応答が JSON としてシリアル化される場合、XmlSerializeString プロパティの値は無視されます。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 クラスの新しいインスタンスを初期化します。Initializes a new instance of the ScriptMethodAttribute class.

プロパティ

ResponseFormat

メソッドの応答形式を取得または設定します。Gets or sets the format of the method response.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)
UseHttpGet

メソッドの呼び出しに HTTP GET を使用するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether to invoke the method by using HTTP GET.

XmlSerializeString

文字列型を含めすべての戻り値の型を XML 形式にシリアル化するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether all return types are serialized as XML, which includes string types.

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

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

一連の名前を対応する一連のディスパッチ識別子にマップします。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください