Enumerable.OrderByDescending(TSource, TKey) Method (IEnumerable(TSource), Func(TSource, TKey), IComparer(TKey))

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

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

static member OrderByDescending : 
        source:IEnumerable<'TSource> * 
        keySelector:Func<'TSource, 'TKey> * 
        comparer:IComparer<'TKey> -> IOrderedEnumerable<'TSource> 

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

Parameters

source
Type: System.Collections.Generic.IEnumerable(TSource)

A sequence of values to order.

keySelector
Type: System.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.IOrderedEnumerable(TSource)
An IOrderedEnumerable(TElement) whose elements are sorted in descending order 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(TSource). 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).

ExceptionCondition
ArgumentNullException

source or keySelector is a 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(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(TElement), which means any number of consecutive calls to ThenBy or ThenByDescending can be made.

NoteNote

Because IOrderedEnumerable(TElement) inherits from IEnumerable(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 a 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.

The following code example demonstrates how to use OrderByDescending(TSource, TKey)(IEnumerable(TSource), Func(TSource, TKey), IComparer(TKey)) to sort the elements of a sequence in descending order by using a transform function and a custom comparer.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.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.

Show:
© 2014 Microsoft