• Article

XNodeDocumentOrderComparer.IComparer.Compare Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Compares two nodes to determine their relative document order.

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

Syntax

'Declaration
Private Function Compare ( _
    x As Object, _
    y As Object _
) As Integer Implements IComparer.Compare

int IComparer.Compare(
    Object x,
    Object y
)

Parameters

Return Value

Type: System.Int32
An Int32 that contains 0 if the nodes are equal; -1 if x is before y; 1 if x is after y.

Implements

IComparer.Compare(Object, Object)

Exceptions

Exception Condition
InvalidOperationException

The two nodes do not share a common ancestor.
ArgumentException

The two nodes are not derived from XNode.

Remarks

We recommend that instead of using this class directly, you use the InDocumentOrder<T> method. This class is used internally by that method.

Version Information

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.