XPathNodeIterator.Current Property (System.Xml.XPath)

Current Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XPathNodeIterator..::.Current Property

When overridden in a derived class, returns the XPathNavigator object for this XPathNodeIterator, positioned on the current context node.

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

Syntax

Visual Basic (Declaration)

Public MustOverride ReadOnly Property Current As XPathNavigator

Visual Basic (Usage)

Dim instance As XPathNodeIterator
Dim value As XPathNavigator

value = instance.Current

public abstract XPathNavigator Current { get; }

Visual C++

public:
virtual property XPathNavigator^ Current {
    XPathNavigator^ get () abstract;
}

JScript

public abstract function get Current () : XPathNavigator

Property Value

Type: System.Xml.XPath..::.XPathNavigator
An XPathNavigator object positioned on the context node from which the node set was selected. The MoveNext method must be called to move the XPathNodeIterator to the first node in the selected set.

Remarks

You can use the properties of the returned XPathNavigator object to obtain information on the current node. However, the returned XPathNavigator object should not be modified. The returned XPathNavigator object cannot be moved away from the selected node set.

Alternatively, you can clone the XPathNavigator object using the Clone method of the XPathNavigator class. The cloned XPathNavigator object can then be moved away from the selected node set. This method of cloning the XPathNavigator object might affect the performance of the XPath query.

If the SelectAncestors, SelectDescendants, and SelectChildren methods result in no nodes being selected, the Current property might not be pointing to the context node.

To test whether nodes have been selected, use the Count property as shown in the following example.

Examples

The following example gets all book titles authored by Herman Melville using the Current property of the XPathNodeIterator object and the Clone method of the XPathNavigator class.

Visual Basic

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

' Select all books authored by Melville.
Dim nodes As XPathNodeIterator = navigator.Select("descendant::book[author/last-name='Melville']")

While nodes.MoveNext()
    ' Clone the navigator returned by the Current property. 
    ' Use the cloned navigator to get the title element.
    Dim clone As XPathNavigator = nodes.Current.Clone()
    clone.MoveToFirstChild()
    Console.WriteLine("Book title: {0}", clone.Value)
End While

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

// Select all books authored by Melville.
XPathNodeIterator nodes = navigator.Select("descendant::book[author/last-name='Melville']");

while (nodes.MoveNext())
{
    // Clone the navigator returned by the Current property. 
    // Use the cloned navigator to get the title element.
    XPathNavigator clone = nodes.Current.Clone();
    clone.MoveToFirstChild();
    Console.WriteLine("Book title: {0}", clone.Value);
}

Visual C++

XPathDocument^ document = gcnew XPathDocument("books.xml");
XPathNavigator^ navigator = document->CreateNavigator();

// Select all books authored by Melville.
XPathNodeIterator^ nodes = navigator->Select("descendant::book[author/last-name='Melville']");

while (nodes->MoveNext())
{
    // Clone the navigator returned by the Current property. 
    // Use the cloned navigator to get the title element.
    XPathNavigator^ clone = nodes->Current->Clone();
    clone->MoveToFirstChild();
    Console::WriteLine("Book title: {0}", clone->Value);
}

The example takes the contosoBooks.xml file as input.

<bookstore xmlns="http://www.contoso.com/books">
    <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>

Platforms

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

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