XNode.CompareDocumentOrder Method (XNode, XNode)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Compares two nodes to determine their relative XML document order.

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

Public Shared Function CompareDocumentOrder (
	n1 As XNode,
	n2 As XNode
) As Integer


Type: System.Xml.Linq.XNode

First XNode to compare.

Type: System.Xml.Linq.XNode

Second XNode to compare.

Return Value

Type: System.Int32

An int containing 0 if the nodes are equal; -1 if n1 is before n2; 1 if n1 is after n2.

Exception Condition

The two nodes do not share a common ancestor.

The XContainer stores its child nodes as a singly-linked list of XNode objects. This means that the CompareDocumentOrder method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent’s child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance.

The following example uses this method.

                Dim xmlTree As XElement = _ 

Dim el1 As XElement = xmlTree...<GrandChild2>(0)
Dim el2 As XElement = xmlTree...<GrandChild6>(0)

If (XElement.CompareDocumentOrder(el1, el2) = 0) Then
    Console.WriteLine("Compared elements are the same element")
ElseIf (XElement.CompareDocumentOrder(el1, el2) > 0) Then
    Console.WriteLine("el1 is after el2")
    Console.WriteLine("el1 is before el2")
End If

This example produces the following output:

el1 is before el2

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top