ScriptMethodAttribute クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
メソッドの呼び出しに使用する 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 AttributePublic NotInheritable Class ScriptMethodAttribute
Inherits Attribute- 継承
- 属性
例
次の例は、 メソッドと EchoStringAndDate メソッドに適用ScriptMethodAttributeしてGetXmlDocument、使用する HTTP 動詞を指定し、応答形式を指定する方法を示しています。
注釈
この属性は、クライアント スクリプトから呼び出すことができるメソッドの情報を指定するために使用されます。 属性を使用すると、メソッドの呼び出しに使用できる HTTP 動詞 (GET または POST) を指定できます。 また、JavaScript Object Notation (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 を戻り値の XmlDocument 型として指定する場合に XmlElement 便利です。 -
文字列型を含むすべての戻り値の型を 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) |
