Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>).IStructuralComparable.CompareTo Method

  • Article
  • 2 minutes to read

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

Compares the current Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) object to a specified object by using a specified comparer and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

Syntax

Private Function CompareTo ( _
    other As Object, _
    comparer As IComparer _
) As Integer Implements IStructuralComparable.CompareTo

int IStructuralComparable.CompareTo(
    Object other,
    IComparer comparer
)

Parameters

Return Value

Type: System..::.Int32
A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

Value

Description

A negative integer

This instance precedes other.

Zero

This instance and other have the same position in the sort order.

A positive integer

This instance follows other.

Implements

IStructuralComparable..::.CompareTo(Object, IComparer)

Exceptions

Exception Condition
ArgumentException

other is not a Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) object.

Remarks

This member is an explicit interface member implementation. It can be used only when the Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) instance is cast to an IStructuralComparable interface.

This method lets you define customized comparisons of Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) objects. For example, you can use this method to order Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) objects based on the value of a specific component.

Although this method can be called directly, it is most commonly called by collection-sorting methods that include IComparer parameters to order the members of a collection, such as the Array..::.Sort(Array, IComparer) method.

Warning

The IStructuralComparable..::.CompareTo method is intended for use in sorting operations. It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. To determine whether two objects are equal, call the IStructuralEquatable..::.Equals(Object, IEqualityComparer) method.

Examples

The following example creates an array of Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) objects that contains population data for three U.S. cities from 1960 to 2000. The sextuple's first component is the city name. The remaining five components represent the population at 10-year intervals from 1960 to 2000.

The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. Two values are provided to the PopulationComparer class in its constructor: The position of the component that defines the sort order, and a Boolean value that indicates whether the tuple objects should be sorted in ascending or descending order.

The example then displays the elements in the array in unsorted order, sorts them by the third component (the population in 1970) and displays them, and then sorts them by the sixth component (the population in 2000) and displays them.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

See Also

Reference

Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) Class

System Namespace