C# Class System.Xml.Xsl.Runtime.XmlSortKey

Base internal class for all sort keys. Inherits from IComparable, so that Array.Sort can perform comparison.

Inheritance: IComparable

Mostra file Open project: dotnet/corefx Class Usage Examples

Public Methods

Method	Description
AddSortKey ( XmlSortKey sortKey ) : XmlSortKey	Sometimes a key is composed of multiple parts. For example: (LastName, FirstName). Multi-part keys are linked together in a list. This method recursively adds a new key part to the end of the list. Returns the first (primary) key in the list.
CompareTo ( object that ) : int	Base internal class is abstract and doesn't actually implement CompareTo; derived classes must do this.

Protected Methods

Method	Description
BreakSortingTie ( XmlSortKey that ) : int	When two keys are compared and found to be equal, the tie must be broken. If there is a secondary key, then use that to break the tie. Otherwise, use the input ordering to break the tie. Since every key has a unique index, this is guaranteed to always break the tie.
CompareToEmpty ( object obj ) : int	Compare a non-empty key (this) to an empty key (obj). The empty sequence always sorts either before all other values, or after all other values.

Method Details

AddSortKey() public method

Sometimes a key is composed of multiple parts. For example: (LastName, FirstName). Multi-part keys are linked together in a list. This method recursively adds a new key part to the end of the list. Returns the first (primary) key in the list.

public AddSortKey ( XmlSortKey sortKey ) : XmlSortKey
sortKey	XmlSortKey
return	XmlSortKey

BreakSortingTie() protected method

When two keys are compared and found to be equal, the tie must be broken. If there is a secondary key, then use that to break the tie. Otherwise, use the input ordering to break the tie. Since every key has a unique index, this is guaranteed to always break the tie.

protected BreakSortingTie ( XmlSortKey that ) : int
that	XmlSortKey
return	int

CompareTo() public abstract method

Base internal class is abstract and doesn't actually implement CompareTo; derived classes must do this.

public abstract CompareTo ( object that ) : int
that	object
return	int

CompareToEmpty() protected method

Compare a non-empty key (this) to an empty key (obj). The empty sequence always sorts either before all other values, or after all other values.

protected CompareToEmpty ( object obj ) : int
obj	object
return	int