Default Property
Collapse the table of content
Expand the table of content

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 Globalizing and Localizing .NET Framework Applications.

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.

foreach (Box bx in Boxes)
        bx.Height.ToString(), bx.Length.ToString(), 

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft