CompareDocumentOrder Method

XNode.CompareDocumentOrder Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Compares two nodes to determine their relative XML document order.

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

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

Parameters

n1
Type: System.Xml.Linq.XNode
First XNode to compare.
n2
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.

ExceptionCondition
InvalidOperationException

The two nodes do not share a common ancestor.

The following example uses this method.


Dim output As New StringBuilder
Dim xmlTree As XElement = _
        <Root>
            <Child1>
                <GrandChild1>1</GrandChild1>
                <GrandChild2>2</GrandChild2>
                <GrandChild3>3</GrandChild3>
            </Child1>
            <Child2>
                <GrandChild4>4</GrandChild4>
                <GrandChild5>5</GrandChild5>
                <GrandChild6>6</GrandChild6>
            </Child2>
        </Root>

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

If (XElement.CompareDocumentOrder(el1, el2) = 0) Then
    output.Append("Compared elements are the same element")
    output.Append(Environment.NewLine)
ElseIf (XElement.CompareDocumentOrder(el1, el2) > 0) Then
    output.Append("el1 is after el2")
    output.Append(Environment.NewLine)
Else
    output.Append("el1 is before el2")
    output.Append(Environment.NewLine)
End If

OutputTextBlock.Text = output.ToString()


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft