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 */
public boolean get_PreserveWhitespace ()

/** @property */
public void set_PreserveWhitespace (boolean value)

public function get PreserveWhitespace () : boolean

public function set PreserveWhitespace (value : boolean)

Property Value

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;
    doc.Load("book.xml");

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

   }
}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    public static void main(String[] args)
    {
        // Load XML data which includes white space, but ignore
        // any white space in the file.
        XmlDocument doc = new XmlDocument();
        doc.set_PreserveWhitespace(false);
        doc.Load("book.xml");

        // Save the document as is (no white space).
        Console.WriteLine("Display the modified XML...");
        doc.set_PreserveWhitespace(true);
        doc.Save(Console.get_Out());
    } //main 
} //Sample

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>
  <price>14.95</price>
</book>

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: