XContainer.DescendantNodes Method (System.Xml.Linq)

Switch View :
ScriptFree
.NET Framework Class Library
XContainer.DescendantNodes Method

Returns a collection of the descendant nodes for this document or element, in document order.

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

Visual Basic
Public Function DescendantNodes As IEnumerable(Of XNode)
C#
public IEnumerable<XNode> DescendantNodes()
Visual C++
public:
IEnumerable<XNode^>^ DescendantNodes()
F#
member DescendantNodes : unit -> IEnumerable<XNode> 

Return Value

Type: System.Collections.Generic.IEnumerable<XNode>
An IEnumerable<T> of XNode containing the descendant nodes of the XContainer, in document order.
Remarks

Note that attributes are not considered to be nodes in LINQ to XML, so they will not be part of the collection that is returned by this method.

This method uses deferred execution.

Examples

The following example creates an XML tree, and then iterates through the DescendantNodes axis.

C#
XElement xmlTree = new XElement("Root",
    // Attributes are not nodes, so will not be returned by DescendantNodes.
    new XAttribute("Att1", "AttributeContent"),
    new XElement("Child",
        new XElement("GrandChild", "element content")
    )
);
IEnumerable<XNode> dnas =
    from node in xmlTree.DescendantNodes()
    select node;
foreach (XNode node in dnas)
{
    if (node is XElement)
        Console.WriteLine((node as XElement).Name);
    else
        Console.WriteLine(node);
}
Visual Basic
' Attributes are not nodes, so will not be returned by DescendantNodes.
Dim xmlTree As XElement = _ 
    <Root Att1="AttributeContent">
        <Child>
            <GrandChild>element content</GrandChild>
        </Child>
    </Root>

Dim dnas = From node In xmlTree.DescendantNodes _
           Select node

For Each node In dnas
    If TypeOf node Is XElement Then
        Console.WriteLine(DirectCast(node, XElement).Name)
    Else
        Console.WriteLine(node)
    End If
Next

This example produces the following output:

Child
GrandChild
element content
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