ScriptMethodAttribute.XmlSerializeString Property

 
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.

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

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

public bool XmlSerializeString { get; set; }

Property Value

Type: System.Boolean

true if all return types are serialized as XML; otherwise, false. The default is false.

When this property is set to false, all return types are serialized as XML, except string, which is interpreted as XML markup. If the value is false, and if the return type is a string, and if the string does not contain XML markup that corresponds to a well-formed XML document, the succeeded callback function will be invoked but the resulting serialized string will be null.

The value of XmlSerializeString is ignored when the ResponseFormat property is set to Json.

The following example shows how to apply ScriptMethodAttribute to a Web method with the XmlSerializeString property set to true. This code example is part of a larger example provided for the ScriptMethodAttribute class.

.NET Framework
Available since 3.5
Return to top
Show: