ScriptMethodAttribute Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies which HTTP verb is used to invoke a method, and the format of the response. This class cannot be inherited.

Namespace:   System.Web.Script.Services
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

SystemObject
   SystemAttribute
    System.Web.Script.ServicesScriptMethodAttribute

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class ScriptMethodAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Method)]
public ref class ScriptMethodAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method)>]
type ScriptMethodAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Method)>
Public NotInheritable Class ScriptMethodAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod ScriptMethodAttribute

Initializes a new instance of the ScriptMethodAttribute class.

NameDescription
System_CAPS_pubproperty

Gets or sets the format of the method response.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubproperty

Gets or sets a value that indicates whether to invoke the method by using HTTP GET.

System_CAPS_pubproperty

Gets or sets a value that indicates whether all return types are serialized as XML, which includes string types.

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

This attribute is used to specify information for methods that can be called from client script. The attribute lets you specify which HTTP verb (GET or POST) can be used to invoke a method. It also lets you specify whether the response is formatted by using either JavaScript Object Notation (JSON) or XML.

The ScriptMethodAttribute attribute is optional. (However, methods that can be called from client script must have the System.Web.ServicesWebMethodAttribute attribute applied.). 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 takes only named parameters. The following are the properties of the ScriptMethodAttribute class that can be used as named parameters:

  • Specifies whether the method will be invoked by using the HTTP GET command. The default is false.

    System_CAPS_security Security Note

    Setting the property to true might pose a security risk for your application if you are working with sensitive data or transactions. In GET requests, the message is encoded by the browser into the URL and is therefore an easier target for tampering. For both GET and POST requests, you should follow security guidelines to protect sensitive data.

  • Specifies whether the response will be serialized as JSON or as XML. The default is Json. The property is useful to specify XML as the return type when the method returns an XmlDocument or an XmlElement object.

  • Specifies whether all return types, including string types, are serialized as XML. The value of the property is ignored when the response is serialized as JSON.

For more information about how to use attributes, see Extending Metadata Using Attributes.

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.


  
.NET Framework
Available since 3.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

WebMethodAttribute
System.Web.Script.Services Namespace
Using Web Services in ASP.NET AJAX
Exposing Web Services to Client Script in ASP.NET AJAX
Calling Web Services from Client Script in ASP.NET AJAX

Return to top