Queryable.OrderBy<TSource, TKey> Method (IQueryable<TSource>, Expression<Func<TSource, TKey>>, IComparer<TKey>)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Sorts the elements of a sequence in ascending order by using a specified comparer.
Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)
Syntax
'Declaration
<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)
public static IOrderedQueryable<TSource> OrderBy<TSource, TKey>(
this IQueryable<TSource> source,
Expression<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 the function that is represented by keySelector.
Parameters
- source
Type: System.Linq.IQueryable<TSource>
A sequence of values to order.
- keySelector
Type: System.Linq.Expressions.Expression<Func<TSource, TKey>>
A function to extract a key from an element.
- comparer
Type: System.Collections.Generic.IComparer<TKey>
An IComparer<T> to compare keys.
Return Value
Type: System.Linq.IOrderedQueryable<TSource>
An IOrderedQueryable<T> 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 IQueryable<TSource>. When you use instance method syntax to call this method, omit the first parameter.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | source or keySelector or comparer is nulla null reference (Nothing in Visual Basic). |
Remarks
This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T, TResult> types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.
The OrderBy<TSource, TKey>(IQueryable<TSource>, Expression<Func<TSource, TKey>>, IComparer<TKey>) method generates a MethodCallExpression that represents calling OrderBy<TSource, TKey>(IQueryable<TSource>, Expression<Func<TSource, TKey>>, IComparer<TKey>) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery<TElement>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter. The result of calling CreateQuery<TElement>(Expression) is cast to type IOrderedQueryable<T> and returned.
The query behavior that occurs as a result of executing an expression tree that represents calling OrderBy<TSource, TKey>(IQueryable<TSource>, Expression<Func<TSource, TKey>>, IComparer<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.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.