Export (0) Print
Expand All

XDocument.Declaration Property

Gets or sets the XML declaration for this document.

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

public XDeclaration Declaration { get; set; }

Property Value

Type: System.Xml.Linq.XDeclaration
An XDeclaration that contains the XML declaration for this document.

Sometimes you have to create an XML declaration for a document. If you want to indicate that a document is standalone, you must use this property. If you want to encode your document with an encoding other than utf-8, you can specify an encoding through the XDeclaration. Another approach for encoding a document is to specify the encoding on an XmlWriter that you pass to LINQ to XML for writing.

The following example uses this property to retrieve the XML declaration of a document.

XDocument doc = new XDocument(
    new XDeclaration("1.0", "utf-8", "yes"),
    new XComment("This is a comment"),
    new XElement("Root", "content")
);

Console.WriteLine(doc.Declaration);

This example produces the following output:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, 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

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft