This documentation is archived and is not being maintained.

XmlDocument.PreserveWhitespace Property

Gets or sets a value indicating whether to preserve white space in element content.

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

public bool PreserveWhitespace { get; set; }

Property Value

Type: System.Boolean
true to preserve white space; otherwise false. The default is false.

This property determines how white space is handled during the load and save process.

If PreserveWhitespace is true before Load or LoadXml is called, white space nodes are preserved; otherwise, if this property is false, significant white space is preserved, white space is not.

If PreserveWhitespace is true before Save is called, white space in the document is preserved in the output; otherwise, if this property is false, XmlDocument auto-indents the output.

This method is a Microsoft extension to the Document Object Model (DOM).

The following example shows how to strip white space from a file.

using System;
using System.IO;
using System.Xml;

public class Sample
  public static void Main()
    //Load XML data which includes white space, but ignore 
    //any white space in the file.
    XmlDocument doc = new XmlDocument();
    doc.PreserveWhitespace = false;

    //Save the document as is (no white space).
    Console.WriteLine("Display the modified XML...");
    doc.PreserveWhitespace = true;

#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
    //Load XML data which includes white space, but ignore
    //any white space in the file.
    XmlDocument* doc = new XmlDocument();
    doc->PreserveWhitespace = false;

    //Save the document as is (no white space).
    Console::WriteLine(S"Display the modified XML...");
    doc->PreserveWhitespace = true;

The example uses the file book.xml as input.

<!--sample XML fragment-->
<book genre='novel' ISBN='1-861003-78' misc='sale-item'>
  <title>The Handmaid's Tale</title>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0