Queryable.ThenByDescending(Of TSource, TKey) Method (IOrderedQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey))


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Performs a subsequent ordering of the elements in a sequence in descending order by using a specified comparer.

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

Public Shared Function ThenByDescending(Of TSource, TKey) (
	source As IOrderedQueryable(Of TSource),
	keySelector As Expression(Of Func(Of TSource, TKey)),
	comparer As IComparer(Of TKey)
) As IOrderedQueryable(Of TSource)


Type: System.Linq.IOrderedQueryable(Of TSource)

An IOrderedQueryable(Of T) that contains elements to sort.

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

A function to extract a key from each element.

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

An IComparer(Of T) to compare keys.

Return Value

Type: System.Linq.IOrderedQueryable(Of TSource)

A collection whose elements are sorted in descending order according to a key.

Type Parameters


The type of the elements of source.


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

Exception Condition

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 ThenBy(Of TSource, TKey)(IOrderedQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey)) method generates a MethodCallExpression that represents calling ThenBy(Of TSource, TKey)(IOrderedQueryable(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 ThenBy(Of TSource, TKey)(IOrderedQueryable(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 performs a secondary sort of the elements of source in descending order, based on the key obtained by invoking keySelector on each element of source. All previously established sort orders are preserved. The comparer parameter is used to compare key values.

The following code example demonstrates how to use ThenByDescending(Of TSource, TKey)(IOrderedQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IComparer(Of TKey)) to perform a secondary ordering of the elements in a sequence in descending order by using a custom comparer.

Class CaseInsensitiveComparer
    Implements IComparer(Of String)

    Function Compare(ByVal x As String, ByVal y As String) As Integer _
        Implements IComparer(Of String).Compare

        ' Compare values and ignore case.
        Return String.Compare(x, y, True)
    End Function
End Class

Sub ThenByDescendingEx1()
    Dim fruits() As String = _
        {"apPLe", "baNanA", "apple", "APple", "orange", "BAnana", "ORANGE", "apPLE"}

    ' Sort the strings first ascending by their length and 
    ' then descending by using a custom case insensitive comparer.
    Dim query = fruits.AsQueryable() _
        .OrderBy(Function(fruit) fruit.Length) _
        .ThenByDescending(Function(fruit) fruit, New CaseInsensitiveComparer())

    Dim output As New System.Text.StringBuilder
    For Each fruit As String In query

    ' Display the results.
End Sub

' This code produces the following output:

' apPLe
' apple
' APple
' apPLE
' orange
' baNanA
' BAnana

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