OrderBy(TSource, TKey) Method (IQueryable(TSource), Expression(Func(TSource, TKey)), IComparer(TKey))

Queryable.OrderBy(Of TSource, TKey) Method (IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey))

 

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 IQueryable(Of TSource),
	keySelector As Expression(Of Func(Of TSource, TKey)),
	comparer As IComparer(Of TKey)
) As IOrderedQueryable(Of TSource)

Parameters

source
Type: System.Linq.IQueryable(Of TSource)

A sequence of values to order.

keySelector
Type: System.Linq.Expressions.Expression(Of Func(Of TSource, TKey))

A function to extract a key from an element.

comparer
Type: System.Collections.Generic.IComparer(Of TKey)

An IComparer(Of T) to compare keys.

Return Value

Type: System.Linq.IOrderedQueryable(Of TSource)

An IOrderedQueryable(Of T) whose elements are sorted according to a key.

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by the function that is represented by keySelector.

Exception Condition
ArgumentNullException

source or keySelector or comparer is null.

This method has at least one parameter of type Expression(Of TDelegate) whose type argument is one of the Func(Of T, TResult) types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression(Of TDelegate).

The OrderBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey)) method generates a MethodCallExpression that represents calling OrderBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey)) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery(Of TElement)(Expression) method of the IQueryProvider represented by the Provider property of the source parameter. The result of calling CreateQuery(Of TElement)(Expression) is cast to type IOrderedQueryable(Of T) and returned.

The query behavior that occurs as a result of executing an expression tree that represents calling OrderBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey)) depends on the implementation of the type of the source parameter. The expected behavior is that it sorts the elements of source based on the key obtained by invoking keySelector on each element of source. The comparer parameter is used to compare keys.

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