This documentation is archived and is not being maintained.

XPathNavigator.ComparePosition Method

Compares the position of the current XPathNavigator with the position of the XPathNavigator specified.

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

public virtual XmlNodeOrder ComparePosition (
	XPathNavigator nav
)
public XmlNodeOrder ComparePosition (
	XPathNavigator nav
)
public function ComparePosition (
	nav : XPathNavigator
) : XmlNodeOrder

Parameters

nav

The XPathNavigator to compare against.

Return Value

An XmlNodeOrder value representing the comparative position of the two XPathNavigator objects.

The following table describes the XmlNodeOrder enumeration.

XmlNodeOrder

Description

Before

The current node of this XPathNavigator is before the current node of the supplied XPathNavigator.

After

The current node of this XPathNavigator is after the current node of the supplied XPathNavigator.

Same

The two XPathNavigator objects are positioned on the same node.

Unknown

The node positions cannot be determined relative to each other in the document order, or a null reference (Nothing in Visual Basic) is specified as the XPathNavigator parameter. This could occur if the two nodes reside in different trees.

The ComparePosition method's behavior is dependent on the XPathNodeType the XPathNavigator is currently positioned on. When comparing nodes in the XML document, the following rules apply:

  • Element nodes: These nodes are returned in document order from the source document.

  • Namespace nodes: These nodes may be returned in document order and are always before the Attribute nodes of the parent element.

  • Attribute nodes: These nodes may be returned in document order. They always come after the Namespace nodes and before any child nodes of the parent node.

NoteNote

For more information about the XPath data model and details about each of the node types, see section 5 of the W3C XML Path Language (XPath) recommendation located at http://www.w3.org/TR/xpath#data-model.

This method has no effect on the state of the XPathNavigator.

NoteNote

Use the IsSamePosition method rather than the ComparePosition method when possible.

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.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: