Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
XNode Class
XNode Methods
Ancestors Method
 Ancestors Method (XName)
.NET Framework Class Library
XNode..::.Ancestors Method (XName)

Updated: November 2007

Returns a filtered collection of the ancestor elements of this node. Only elements that have a matching XName are included in the collection.

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

Visual Basic (Declaration)
Public Function Ancestors ( _
    name As XName _
) As IEnumerable(Of XElement)
Visual Basic (Usage)
Dim instance As XNode
Dim name As XName
Dim returnValue As IEnumerable(Of XElement)

returnValue = instance.Ancestors(name)
C#
public IEnumerable<XElement> Ancestors(
    XName name
)
Visual C++
public:
IEnumerable<XElement^>^ Ancestors(
    XName^ name
)
J#
public IEnumerable<XElement> Ancestors(
    XName name
)
JScript
public function Ancestors(
    name : XName
) : IEnumerable<XElement>

Parameters

name
Type: System.Xml.Linq..::.XName

The XName to match.

Return Value

Type: System.Collections.Generic..::.IEnumerable<(Of <(XElement>)>)

An IEnumerable<(Of <(T>)>) of XElement of the ancestor elements of this node. Only elements that have a matching XName are included in the collection.

The nodes in the returned collection are in reverse document order.

This method uses deferred execution.

This method will not return itself in the results.

The following example uses this method.

C#
XElement xmlTree = new XElement("Root",
    new XElement("Child", 
        new XElement("GrandChild", "content")
    )
);
IEnumerable<XElement> grandChild = xmlTree.Descendants("GrandChild");
foreach (XElement el in grandChild.Ancestors("Child"))
    Console.WriteLine(el.Name);
Visual Basic
Dim xmlTree As XElement = _ 
        <Root>
            <Child>
                <GrandChild>content</GrandChild>
            </Child>
        </Root>

Dim grandChild As IEnumerable(Of XElement) = xmlTree...<GrandChild>
For Each el In grandChild.Ancestors("Child")
    Console.WriteLine(el.Name)
Next

This example produces the following output:

Child

Windows Vista, Windows XP SP2, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.

.NET Framework

Supported in: 3.5

.NET Compact Framework

Supported in: 3.5
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker