This documentation is archived and is not being maintained.

XPathNavigator.NavigatorComparer Property

Gets an IEqualityComparer used for equality comparison of XPathNavigator objects.

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

public static IEqualityComparer NavigatorComparer { get; }

Property Value

Type: System.Collections.IEqualityComparer
An IEqualityComparer used for equality comparison of XPathNavigator objects.

The NavigatorComparer property allows XPathNavigator objects to be compared on the basis of position rather than reference to the object. The ComparePosition and Equals methods implemented by this class are based on the position of the XPathNavigator objects passed as parameters. The GetHashCode method implemented by this class uses the properties of the node such as its local name and namespace URI to create a hash code for the node.

The following example illustrates the use of the NavigatorComparer property.

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

// Add nodes to the Hashtable.
foreach (XPathNavigator navigator2 in navigator.Select("//book"))
    object value = navigator2.Evaluate("string(./title)");
    table.Add(navigator2.Clone(), value);
    Console.WriteLine("Added book with title {0}", value);

Console.WriteLine("Does the Hashtable have the book \"The Confidence Man\"?");
Console.WriteLine(table.Contains(navigator.SelectSingleNode("//book[title='The Confidence Man']")));

The example takes the books.xml file as an input.

<?xml version="1.0" encoding="utf-8" ?> 
    <book genre="autobiography" publicationdate="1981-03-22" ISBN="1-861003-11-0">
        <title>The Autobiography of Benjamin Franklin</title>
    <book genre="novel" publicationdate="1967-11-17" ISBN="0-201-63361-2">
        <title>The Confidence Man</title>
    <book genre="philosophy" publicationdate="1991-02-15" ISBN="1-861001-57-6">
        <title>The Gorgias</title>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.