XmlWriterSettings.OmitXmlDeclaration Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets a value indicating whether to write an XML declaration.

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

public bool OmitXmlDeclaration { get; set; }
/** @property */
public boolean get_OmitXmlDeclaration ()

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

public function get OmitXmlDeclaration () : boolean

public function set OmitXmlDeclaration (value : boolean)

Property Value

true to omit the XML declaration; otherwise false. The default is false, an XML declaration is written.

This property only applies to XmlWriter instances that output text content; otherwise, this setting is ignored.

If OmitXmlDeclaration is set to false, The XML declaration is written automatically

The XML declaration is always written if ConformanceLevel is set to Document, even if OmitXmlDeclaration is set to false.

The XML declaration is never written if ConformanceLevel is set to Fragment. You can call WriteProcessingInstruction to explicitly write out an XML declaration.

The following example writes an XML fragment to a memory stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");

// Do additonal processing on the stream.

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

.NET Compact Framework

Supported in: 2.0