Enumerable.OrderBy(Of TSource, TKey) Method (IEnumerable(Of TSource), Func(Of TSource, TKey), IComparer(Of TKey))
Sorts the elements of a sequence in ascending order by using a specified comparer.
Assembly: System.Core (in System.Core.dll)
'Declaration <ExtensionAttribute> _ Public Shared Function OrderBy(Of TSource, TKey) ( _ source As IEnumerable(Of TSource), _ keySelector As Func(Of TSource, TKey), _ comparer As IComparer(Of TKey) _ ) As IOrderedEnumerable(Of TSource)
The type of the elements of source.
The type of the key returned by keySelector.
- Type: System.Collections.Generic.IEnumerable(Of )
A sequence of values to order.
- Type: System.Func(Of , )
A function to extract a key from an element.
Return ValueType: System.Linq.IOrderedEnumerable(Of )
An IOrderedEnumerable(Of TElement) whose elements are sorted according to a key.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(Of ). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.
To order a sequence by the values of the elements themselves, specify the identity function (x => x in Visual C# or Function(x) x in Visual Basic) for keySelector.
Two methods are defined to extend the type IOrderedEnumerable(Of TElement), which is the return type of this method. These two methods, namely ThenBy and ThenByDescending, enable you to specify additional sort criteria to sort a sequence. ThenBy and ThenByDescending also return an IOrderedEnumerable(Of TElement), which means any number of consecutive calls to ThenBy or ThenByDescending can be made.
Because IOrderedEnumerable(Of TElement) inherits from IEnumerable(Of T), you can call OrderBy or OrderByDescending on the results of a call to OrderBy, OrderByDescending, ThenBy or ThenByDescending. Doing this introduces a new primary ordering that ignores the previously established ordering.
If comparer is Nothing, the default comparer Default is used to compare keys.
This method performs a stable sort; that is, if the keys of two elements are equal, the order of the elements is preserved. In contrast, an unstable sort does not preserve the order of elements that have the same key.
.NET FrameworkSupported in: 4.5.2, 4.5.1, 4.5, 4, 3.5
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported 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.