Comparer(T) Class
Collapse the table of content
Expand the table of content

Comparer<T> Class

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

Provides a base class for implementations of the IComparer<T> generic interface.

System::Object
  System.Collections.Generic::Comparer<T>

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

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

Type Parameters

T

The type of objects to compare.

The Comparer<T> type exposes the following members.

  NameDescription
Protected methodComparer<T>Initializes a new instance of the Comparer<T> class.
Top

  NameDescription
Public propertyStatic memberDefaultReturns a default sort order comparer for the type specified by the generic argument.
Top

  NameDescription
Public methodCompareWhen overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one object is less than, equal to, or greater than the other.
Public methodStatic memberCreateCreates a comparer by using the specified comparison.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIComparer::CompareCompares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
Top

Derive from this class to provide a custom implementation of the IComparer<T> interface for use with collection classes.

The object returned by the Default property uses the System::IComparable<T> generic interface (IComparable<T> in C#, IComparable(Of T) in Visual Basic) to compare two objects. If type T does not implement the System::IComparable<T> generic interface, the Default property returns a Comparer<T> that uses the System::IComparable interface.

Notes to Implementers

Compare and EqualityComparer<T>::Equals may behave differently in terms of culture-sensitivity and case-sensitivity.

For string comparisons, the StringComparer class is recommended over Comparer<String>. Properties of the StringComparer class return predefined instances that perform string comparisons with different combinations of culture-sensitivity and case-sensitivity. The case-sensitivity and culture-sensitivity are consistent among the members of the same StringComparer instance.

For more information on culture-specific comparisons, see the System.Globalization namespace.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2017 Microsoft