XDocument.Declaration Property

Definition

Namespace:

System.Xml.Linq

Assemblies:

netstandard.dll, System.Xml.XDocument.dll

Source:

XDocument.cs

Gets or sets the XML declaration for this document.

C#

public System.Xml.Linq.XDeclaration? Declaration { get; set; }

Property Value

XDeclaration

An XDeclaration that contains the XML declaration for this document.

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);

This example produces the following output:

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

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.

Applies to

See also

• XDeclaration
• LINQ to XML overview
• How to read and write an encoded document