ScriptMethodAttribute Klasse

Definition

Gibt das zum Aufrufen einer Methode verwendete HTTP-Verb sowie das Format der Antwort an.Specifies which HTTP verb is used to invoke a method, and the format of the response. Diese Klasse kann nicht vererbt werden.This class cannot be inherited.

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
Vererbung
ScriptMethodAttribute
Attribute

Beispiele

Im folgenden Beispiel wird gezeigt, wie ScriptMethodAttribute Sie auf die Methoden und anwenden können, GetXmlDocument EchoStringAndDate um anzugeben, welches http-Verb verwendet werden soll, und um das Antwortformat anzugeben.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.

Hinweise

Dieses Attribut wird verwendet, um Informationen für Methoden anzugeben, die vom Client Skript aufgerufen werden können.This attribute is used to specify information for methods that can be called from client script. Mithilfe des-Attributs können Sie angeben, welches http-Verb (Get oder Post) zum Aufrufen einer Methode verwendet werden kann.The attribute lets you specify which HTTP verb (GET or POST) can be used to invoke a method. Außerdem können Sie angeben, ob die Antwort entweder mithilfe von JavaScript Object Notation (JSON) oder XML formatiert wird.It also lets you specify whether the response is formatted by using either JavaScript Object Notation (JSON) or XML.

Das ScriptMethodAttribute-Attribut ist optional.The ScriptMethodAttribute attribute is optional. (Auf Methoden, die vom Client Skript aufgerufen werden können, muss jedoch das- System.Web.Services.WebMethodAttribute Attribut angewendet werden.)(However, methods that can be called from client script must have the System.Web.Services.WebMethodAttribute attribute applied.). Wenn eine Methode nicht mit markiert ist ScriptMethodAttribute , wird die Methode mithilfe des HTTP Post-Befehls aufgerufen, und die Antwort wird als JSON serialisiert.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. Sie können diese Einstellung nicht über das Skript überschreiben.You cannot override this setting from script.

ScriptMethodAttribute nimmt nur benannte Parameter an.ScriptMethodAttribute takes only named parameters. Im folgenden sind die Eigenschaften der- ScriptMethodAttribute Klasse aufgeführt, die als benannte Parameter verwendet werden können:The following are the properties of the ScriptMethodAttribute class that can be used as named parameters:

  • UseHttpGet

    Gibt an, ob die Methode mithilfe des HTTP Get-Befehls aufgerufen wird.Specifies whether the method will be invoked by using the HTTP GET command. Der Standardwert ist false.The default is false.

    Wichtig

    UseHttpGetWenn Sie die-Eigenschaft auf festlegen, true können Sie ein Sicherheitsrisiko für Ihre Anwendung darstellen, wenn Sie mit sensiblen Daten oder Transaktionen arbeiten.Setting the UseHttpGet property to true might pose a security risk for your application if you are working with sensitive data or transactions. In Get-Anforderungen wird die Nachricht vom Browser in die URL codiert und ist daher ein einfacheres Ziel für Manipulationen.In GET requests, the message is encoded by the browser into the URL and is therefore an easier target for tampering. Für Get-und Post-Anforderungen sollten Sie die Sicherheitsrichtlinien befolgen, um sensible Daten zu schützen.For both GET and POST requests, you should follow security guidelines to protect sensitive data.

  • ResponseFormat

    Gibt an, ob die Antwort als JSON oder XML serialisiert werden soll.Specifies whether the response will be serialized as JSON or as XML. Der Standardwert ist Json.The default is Json. Die- ResponseFormat Eigenschaft ist nützlich, um XML als Rückgabetyp anzugeben, wenn die Methode ein- XmlDocument Objekt oder ein-Objekt zurückgibt XmlElement .The ResponseFormat property is useful to specify XML as the return type when the method returns an XmlDocument or an XmlElement object.

  • XmlSerializeString

    Gibt an, ob alle Rückgabe Typen, einschließlich Zeichen folgen Typen, als XML serialisiert werden.Specifies whether all return types, including string types, are serialized as XML. Der Wert der- XmlSerializeString Eigenschaft wird ignoriert, wenn die Antwort als JSON serialisiert wird.The value of the XmlSerializeString property is ignored when the response is serialized as JSON.

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about how to use attributes, see Attributes.

Konstruktoren

ScriptMethodAttribute()

Initialisiert eine neue Instanz der ScriptMethodAttribute-Klasse.Initializes a new instance of the ScriptMethodAttribute class.

Eigenschaften

ResponseFormat

Ruft das Format der Methodenantwort ab oder legt dieses fest.Gets or sets the format of the method response.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
UseHttpGet

Ruft einen Wert ab, der angibt, ob die Methode mit HTTP-GET aufgerufen werden soll, oder legt diesen fest.Gets or sets a value that indicates whether to invoke the method by using HTTP GET.

XmlSerializeString

Ruft einen Wert ab, der angibt, ob alle Rückgabetypen, einschließlich der Zeichenfolgentypen, als XML serialisiert werden, oder legt diesen fest.Gets or sets a value that indicates whether all return types are serialized as XML, which includes string types.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch