System.IComparable

Defines a generalized type-specific comparison method that a value type or class implements to order or sort its instances.

See Also: IComparable Members

Syntax

[System.Runtime.InteropServices.ComVisible(true)]
public interface IComparable

Remarks

This interface is implemented by types whose values can be ordered or sorted. It requires that implementing types define a single method, IComparable.CompareTo(object), that indicates whether the position of the current instance in the sort order is before, after, or the same as a second object of the same type. The instance's IComparable implementation is called automatically by methods such as Array.Sort(Array) and ArrayList.Sort.

The implementation of the IComparable.CompareTo(object) method must return an int that has one of three values, as shown in the following table.

Less than zero

The current instance precedes the object specified by the IComparable.CompareTo(object) method in the sort order.

Zero

This current instance occurs in the same position in the sort order as the object specified by the IComparable.CompareTo(object) method.

Greater than zero

This current instance follows the object specified by the IComparable.CompareTo(object) method in the sort order.

All numeric types (such as int and double) implement IComparable, as do string, char, and DateTime. Custom types should also provide their own implementation of IComparable to enable object instances to be ordered or sorted.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0