XPathNodeIterator Class (System.Xml.XPath)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

XPathNodeIterator Class

Provides an iterator over a selected set of nodes.

Namespace: System.Xml.XPath
Assembly: System.Xml (in system.xml.dll)

Syntax

Visual Basic (Declaration)

Public MustInherit Class XPathNodeIterator
    Implements ICloneable, IEnumerable

Visual Basic (Usage)

Dim instance As XPathNodeIterator

public abstract class XPathNodeIterator : ICloneable, IEnumerable

C++

public ref class XPathNodeIterator abstract : ICloneable, IEnumerable

public abstract class XPathNodeIterator implements ICloneable, IEnumerable

JScript

public abstract class XPathNodeIterator implements ICloneable, IEnumerable

Remarks

An XPathNodeIterator object returned by the XPathNavigator class is not positioned on the first node in a selected set of nodes. A call to the MoveNext method of the XPathNodeIterator class must be made to position the XPathNodeIterator object on the first node in the selected set of nodes.

Notes to Inheritors When you inherit from the XPathNodeIterator class, you must override the following members:

Clone
Current
CurrentPosition
MoveNext

Example

The following example uses the Select method of the XPathNavigator class to select a node set using the XPathNodeIterator class.

Visual Basic

Dim document As XPathDocument = New XPathDocument("books.xml")
Dim navigator As XPathNavigator = document.CreateNavigator()

Dim nodes As XPathNodeIterator = navigator.Select("/bookstore/book")
Dim nodesNavigator As XPathNavigator = nodes.Current

Dim nodesText As XPathNodeIterator = nodesNavigator.SelectDescendants(XPathNodeType.Text, False)

While nodesText.MoveNext()
    Console.Write(nodesText.Current.Name)
    Console.WriteLine(nodesText.Current.Value)
End While

XPathDocument document = new XPathDocument("books.xml");
XPathNavigator navigator = document.CreateNavigator();

XPathNodeIterator nodes = navigator.Select("/bookstore/book");
XPathNavigator nodesNavigator = nodes.Current;

XPathNodeIterator nodesText = nodesNavigator.SelectDescendants(XPathNodeType.Text, false);

while (nodesText.MoveNext())
{
    Console.Write(nodesText.Current.Name);
    Console.WriteLine(nodesText.Current.Value);
}

The example takes the books.xml file as input.

<bookstore>
    <book genre="autobiography" publicationdate="1981-03-22" ISBN="1-861003-11-0">
        <title>The Autobiography of Benjamin Franklin</title>
        <author>
            <first-name>Benjamin</first-name>
            <last-name>Franklin</last-name>
        </author>
        <price>8.99</price>
    </book>
    <book genre="novel" publicationdate="1967-11-17" ISBN="0-201-63361-2">
        <title>The Confidence Man</title>
        <author>
            <first-name>Herman</first-name>
            <last-name>Melville</last-name>
        </author>
        <price>11.99</price>
    </book>
    <book genre="philosophy" publicationdate="1991-02-15" ISBN="1-861001-57-6">
        <title>The Gorgias</title>
        <author>
            <name>Plato</name>
        </author>
        <price>9.99</price>
    </book>
</bookstore>

Inheritance Hierarchy

System.Object
System.Xml.XPath.XPathNodeIterator

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

XPathNodeIterator Members
System.Xml.XPath Namespace