Export (0) Print
Expand All

ScriptMethodAttribute.XmlSerializeString Property

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.

[WebMethod]
[ScriptMethod(ResponseFormat = ResponseFormat.Xml, 
    XmlSerializeString = true)]
public string GetString()
{
    return "Hello World";           
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft