IComparable(T).CompareTo Method

Compares the current object with another object of the same type.

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

abstract CompareTo : 
        other:'T -> int

Parameters

other
Type: T

An object to compare with this object.

Return Value

Type: System.Int32
A value that indicates the relative order of the objects being compared. The return value has the following meanings:

Value

Meaning

Less than zero

This object is less than the other parameter.

Zero

This object is equal to other.

Greater than zero

This object is greater than other.

CompareTo provides a strongly typed comparison method for ordering members of a generic collection object. Because of this, it is usually not called directly from developer code. Instead, it is called automatically by methods such as List(T).Sort() and Add.

This method is only a definition and must be implemented by a specific class or value type to have effect. The meaning of the comparisons, "less than," "equal to," and "greater than," depends on the particular implementation.

By definition, any object compares greater than a null reference (Nothing in Visual Basic), and two null references compare equal to each other.

Notes to Implementers

For objects A, B, and C, the following must be true:

A.CompareTo(A) is required to return zero.

If A.CompareTo(B) returns zero, then B.CompareTo(A) is required to return zero.

If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) is required to return zero.

If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) is required to return a value of the opposite sign.

If A.CompareTo(B) returns a value x that is not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) is required to return a value of the same sign as x and y.

Notes to Callers

Use the CompareTo method to determine the ordering of instances of a class.

The following code example illustrates the implementation of IComparable for a simple Temperature object. The example creates a SortedList(TKey, TValue) collection of strings with Temperature object keys, and adds several pairs of temperatures and strings to the list out of sequence. In the call to the Add method, the SortedList(TKey, TValue) collection uses the IComparable(T) implementation to sort the list entries, which are then displayed in order of increasing temperature.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft