Export (0) Print
Expand All

Comparer<T>.Default Property

Returns a default sort order comparer for the type specified by the generic argument.

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

public static Comparer<T> Default { get; }

Property Value

Type: System.Collections.Generic.Comparer<T>
An object that inherits Comparer<T> and serves as a sort order comparer for type T.

The Comparer<T> returned by this 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, this property returns a Comparer<T> that uses the System.IComparable interface.

Notes to Callers:

For string comparisons, the StringComparer class is recommended over Comparer<String> (Comparer(Of String) in Visual Basic). 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 and Encoding and Localization.

The following example shows how to use the Default property to get an object that performs the default comparison. This example is part of a larger example provided for the Comparer<T> class.

// Get the default comparer that  
// sorts first by the height.
Comparer<Box> defComp = Comparer<Box>.Default;

// Calling Boxes.Sort() with no parameter 
// is the same as calling Boxs.Sort(defComp) 
// because they are both using the default comparer.
Boxes.Sort();

foreach (Box bx in Boxes)
{
    Console.WriteLine("{0}\t{1}\t{2}",
        bx.Height.ToString(), bx.Length.ToString(), 
        bx.Width.ToString());
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

Added example.

Information enhancement.

Community Additions

ADD
Show:
© 2014 Microsoft