XDocument.Declaration Property (System.Xml.Linq)

Switch View :
ScriptFree
.NET Framework Class Library
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)
Syntax

Visual Basic
Public Property Declaration As XDeclaration
	Get
	Set
C#
public XDeclaration Declaration { get; set; }
Visual C++
public:
property XDeclaration^ Declaration {
	XDeclaration^ get ();
	void set (XDeclaration^ value);
}
F#
member Declaration : XDeclaration with get, set

Property Value

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

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.

Examples

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

C#
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);
Visual Basic
Dim doc As XDocument = _
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
        <!--This is a comment-->
        <Root>content</Root>

Console.WriteLine(doc.Declaration)

This example produces the following output:

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

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Other Resources