Extensions::Ancestors<T> Method (IEnumerable<T>, XName)
Returns a filtered collection of elements that contains the ancestors of every node in the source collection. Only elements that have a matching XName are included in the collection.
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)
[ExtensionAttribute] public: generic<typename T> where T : XNode static IEnumerable<XElement^>^ Ancestors( IEnumerable<T>^ source, XName^ name )
Type Parameters
- T
The type of the objects in source, constrained to XNode.
Parameters
- source
- Type: System.Collections.Generic::IEnumerable<T>
An IEnumerable<T> of XNode that contains the source collection.
- name
- Type: System.Xml.Linq::XName
The XName to match.
Return Value
Type: System.Collections.Generic::IEnumerable<XElement>An IEnumerable<T> of XElement that contains the ancestors of every node in the source collection. Only elements that have a matching XName are included in the collection.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).If multiple nodes in the source collection have the same ancestor with a matching XName, the ancestor will be included multiple times in the result collection.
This method uses deferred execution.
The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors of all elements in the collection that match a specified XName.
This example produces the following output:
Great Grand Children Elements ---- GreatGrandChild1 GreatGrandChild2 Ancestors ---- Child1
The following is the same example, but in this case the XML is in a namespace. For more information, see Working with XML Namespaces.
This example produces the following output:
Great Grand Children Elements
----
{http://www.adventure-works.com}GreatGrandChild1
{http://www.adventure-works.com}GreatGrandChild2
Ancestors
----
{http://www.adventure-works.com}Child1
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.