ScriptMethodAttribute.ResponseFormat Property


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

Gets or sets the format of the method response.

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

Public Property ResponseFormat As ResponseFormat

Property Value

Type: System.Web.Script.Services.ResponseFormat

One of the ResponseFormat values. The default is Json.

Use the ResponseFormat property when you want to specify XML as the format for the return type. This is useful when the method returns an XmlDocument or an XmlElement object.

When the ResponseFormat property is set to Xml, the public fields and properties of the return type that have the ScriptIgnoreAttribute attribute applied will not be ignored. This is because they will be serialized by using the XmlSerializer object instead of the JavaScriptSerializer object. You must apply the XmlIgnoreAttribute attribute to make XmlSerializer ignore, or skip, those public fields and properties of the return type.

The following example shows how to apply the ScriptMethodAttribute attribute to a Web method with the ResponseFormat property set to Xml. The return value of the method will be serialized as XML and sent to the succeeded callback function as an object of type XmlDocument. This code example is part of a larger example provided for the ScriptMethodAttribute class.

.NET Framework
Available since 3.5
Return to top