Enumerable.OrderBy<(Of <(TSource, TKey>)>) Method (IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, TKey>)>), IComparer<(Of <(TKey>)>))

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

Sorts the elements of a sequence in ascending order by using a specified comparer.

Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)


<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)
public static IOrderedEnumerable<TSource> OrderBy<TSource, TKey>(
    this IEnumerable<TSource> source,
    Func<TSource, TKey> keySelector,
    IComparer<TKey> comparer

Type Parameters

  • TSource
    The type of the elements of source.
  • TKey
    The type of the key returned by keySelector.


  • keySelector
    Type: System..::.Func<(Of <(TSource, TKey>)>)
    A function to extract a key from an element.

Return Value

Type: System.Linq..::.IOrderedEnumerable<(Of <(TSource>)>)
An IOrderedEnumerable<(Of <(TElement>)>) whose elements are sorted according to a key.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<(Of <(TSource>)>). When you use instance method syntax to call this method, omit the first parameter.


Exception Condition

source or keySelector is nullNothingnullptra null reference (Nothing in Visual Basic).


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 Enumerable.OrderBy or Enumerable.OrderByDescending on the results of a call to Enumerable.OrderBy, Enumerable.OrderByDescending, Enumerable.ThenBy or Enumerable.ThenByDescending. Doing this introduces a new primary ordering that ignores the previously established ordering.

If comparer is nullNothingnullptra null reference (Nothing in Visual Basic), 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.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0


Windows Phone

See Also


Enumerable Class

OrderBy Overload

System.Linq Namespace