.NET Framework Class Library
XDocument..::.Root Property

Gets the root element of the XML Tree for this document.

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

Visual Basic (Declaration)
Public ReadOnly Property Root As XElement
Visual Basic (Usage)
Dim instance As XDocument
Dim value As XElement

value = instance.Root
C#
public XElement Root { get; }
Visual C++
public:
property XElement^ Root {
    XElement^ get ();
}
JScript
public function get Root () : XElement

Property Value

Type: System.Xml.Linq..::.XElement
The root XElement of the XML tree.
Remarks

This property is useful when you want to compose LINQ to XML queries in the same context as when composing them for a tree rooted in XElement. See Querying an XDocument vs. Querying an XElement for more details.

Examples

The following example uses this property to get the root element of a document.

C#
XDocument doc = new XDocument(
    new XComment("This is a comment."),
    new XElement("Pubs", 
        new XElement("Book",
            new XElement("Title", "Artifacts of Roman Civilization"),
            new XElement("Author", "Moreno, Jordao")
        ),
        new XElement("Book",
            new XElement("Title", "Midieval Tools and Implements"),
            new XElement("Author", "Gazit, Inbar")
        )
    ),
    new XComment("This is another comment.")
);
Console.WriteLine(doc.Root.Name.ToString());
Visual Basic
Dim doc As XDocument = _
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <!--This is a comment.-->
    <Pubs>
        <Book>
            <Title>Artifacts of Roman Civilization</Title>
            <Author>Moreno, Jordao</Author>
        </Book>
        <Book>
            <Title>Midieval Tools and Implements</Title>
            <Author>Gazit, Inbar</Author>
        </Book>
        <!--This is another comment.-->
    </Pubs>

Console.WriteLine(doc.Root.Name.ToString())

This example produces the following output:

Pubs
Platforms

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.
Version Information

.NET Framework

Supported in: 3.5

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0
See Also

Reference

Other Resources

Tags :


Page view tracker