Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

Comparer(Of 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)
'Declaration
Public Shared ReadOnly Property Default As Comparer(Of T)

Property Value

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

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

		' Get the default comparer that  
		' sorts first by the height. 
		Dim defComp As Comparer(Of Box) = Comparer(Of 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()

		For Each bx As Box In Boxes
            Console.WriteLine("{0}" & vbTab & "{1}" & vbTab & "{2}", _
                              bx.Height.ToString(), _
                              bx.Length.ToString(), _
                              bx.Width.ToString())
		Next bx

.NET Framework

Supported in: 4.5.1, 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 8, Silverlight 8.1

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.