XDocument.Declaration XDocument.Declaration XDocument.Declaration XDocument.Declaration Property

Definition

Gets or sets the XML declaration for this document.

public:
 property System::Xml::Linq::XDeclaration ^ Declaration { System::Xml::Linq::XDeclaration ^ get(); void set(System::Xml::Linq::XDeclaration ^ value); };
public System.Xml.Linq.XDeclaration Declaration { get; set; }
member this.Declaration : System.Xml.Linq.XDeclaration with get, set
Public Property Declaration As XDeclaration

Property Value

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.

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

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