Article
11/18/2011

XNodeDocumentOrderComparer Class

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

Contains functionality to compare nodes for their document order. This class cannot be inherited.

Inheritance Hierarchy

System.Object
System.Xml.Linq.XNodeDocumentOrderComparer

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

Syntax

'Declaration
Public NotInheritable Class XNodeDocumentOrderComparer _
    Implements IComparer(Of XNode)

public sealed class XNodeDocumentOrderComparer : IComparer<XNode>

The XNodeDocumentOrderComparer type exposes the following members.

Constructors

	Name	Description
	XNodeDocumentOrderComparer	Initializes a new instance of the XNodeDocumentOrderComparer class.

Top

Methods

	Name	Description
	Compare	Compares two nodes to determine their relative document order.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IComparer.Compare	Compares two nodes to determine their relative document order.

Top

Remarks

This class implements IComparer and IComparer<XNode>.

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

Examples

The following example uses of this class to compare the document order for two nodes.

StringBuilder output = new StringBuilder();
XElement xmlTree = new XElement("Root",
    new XText("Text content."),
    new XElement("Child1", "child1 content"),
    new XElement("Child2", "child2 content"),
    new XElement("Child3", "child3 content"),
    new XText("More text content."),
    new XElement("Child4", "child4 content"),
    new XElement("Child5", "child5 content")
);
XElement child3 = xmlTree.Element("Child3");
XElement child5 = xmlTree.Element("Child5");
XNodeDocumentOrderComparer documentOrderComparer = new XNodeDocumentOrderComparer();
int val = documentOrderComparer.Compare(child3, child5);
if (val == 0)
    output.Append("Child3 is same as Child5" + Environment.NewLine);
else if (val < 0)
    output.Append("Child3 is before Child5" + Environment.NewLine);
else
    output.Append("Child3 is after Child5" + Environment.NewLine);

OutputTextBlock.Text = output.ToString();

Version Information

Silverlight

Supported in: 5, 4, 3

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via