• Article

XStreamingElement.ToString Method (SaveOptions)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns the XML for this streaming element, optionally disabling formatting.

Namespace:  System.Xml.Linq
Assembly:  System.Xml.Linq (in System.Xml.Linq.dll)

Syntax

'Declaration
Public Function ToString ( _
    options As SaveOptions _
) As String

public string ToString(
    SaveOptions options
)

Parameters

Return Value

Type: System.String
A String containing the XML.

Remarks

Note that when debugging a program that uses XStreamingElement, displaying the value of an object causes its ToString method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience.

Examples

The following example shows two uses of ToString. The first use preserves white space. The second one serializes the XStreamingElement with formatting.

Dim output As New StringBuilder
Dim srcTree As XElement = _
    <Root>
        <Child>1</Child>
        <Child>2</Child>
        <Child>3</Child>
        <Child>4</Child>
        <Child>5</Child>
    </Root>

Dim dstTree As XStreamingElement = New XStreamingElement("NewRoot", _
                        From el In srcTree.Elements() _
                        Where el.Value = 3 _
                        Select <DifferentChild><%= el.Value %></DifferentChild> _
                    )

output.Append(dstTree.ToString(SaveOptions.DisableFormatting))
output.Append(Environment.NewLine)
output.Append("------")
output.Append(Environment.NewLine)
output.Append(dstTree.ToString())
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
XElement srcTree = new XElement("Root",
                       new XElement("Child", 1),
                       new XElement("Child", 2),
                       new XElement("Child", 3),
                       new XElement("Child", 4),
                       new XElement("Child", 5)
                   );

XStreamingElement dstTree = new XStreamingElement("NewRoot",
                        from el in srcTree.Elements()
                        where (int)el == 3
                        select new XElement("DifferentChild", (int)el)
                    );

output.Append(dstTree.ToString(SaveOptions.DisableFormatting) + Environment.NewLine);
output.Append("------" + Environment.NewLine);
output.Append(dstTree.ToString() + Environment.NewLine);

OutputTextBlock.Text = output.ToString();

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.