Save Method (TextWriter, SaveOptions)

XDocument.Save Method (TextWriter, SaveOptions)


Serialize this XDocument to a TextWriter, optionally disabling formatting.

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

public void Save(
	TextWriter textWriter,
	SaveOptions options


Type: System.IO.TextWriter

The TextWriter to output the XML to.

Type: System.Xml.Linq.SaveOptions

A SaveOptions that specifies formatting behavior.

If you want to save unindented XML, specify the DisableFormatting flag for options. This will cause the writer to write all white space exactly as represented in the XML tree.

If you want to save indented XML, do not specify the DisableFormatting flag for options. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the Save methods that do not take options as a parameter.

For more information, see Preserving White Space while Loading or Parsing XML and Preserving White Space While Serializing.

The following example shows two uses of this method. The first use serializes the XDocument with formatting. The second preserves white space. Because the document has no white space in it as constructed, preserving white space outputs the XML without any indenting.

XDocument doc = new XDocument(
    new XElement("Root",
        new XElement("Child", "content")
StringBuilder sb1 = new StringBuilder();
using (StringWriter sr1 = new StringWriter(sb1)) {
    doc.Save(sr1, SaveOptions.None);

StringBuilder sb2 = new StringBuilder();
using (StringWriter sr2 = new StringWriter(sb2)) {
    doc.Save(sr2, SaveOptions.DisableFormatting);

This example produces the following output:

<?xml version="1.0" encoding="utf-16"?>
<?xml version="1.0" encoding="utf-16"?><Root><Child>content</Child></Root>

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft