Queryable.OrderBy Método

Definição

Namespace:

System.Linq

Assembly:

System.Linq.Queryable.dll

Classifica os elementos de uma sequência em ordem crescente.

Sobrecargas

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)	Classifica os elementos de uma sequência em ordem crescente usando um comparador especificado.
OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)	Classifica os elementos de uma sequência em ordem crescente de acordo com uma chave.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)

Origem:

Queryable.cs

Classifica os elementos de uma sequência em ordem crescente usando um comparador especificado.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderBy(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ comparer);

public static System.Linq.IOrderedQueryable<TSource> OrderBy<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector, System.Collections.Generic.IComparer<TKey>? comparer);

static member OrderBy : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public 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)

Parâmetros de tipo

TSource

O tipo dos elementos de source.

TKey

O tipo da chave retornada pela função que é representada por keySelector.

Parâmetros

source

IQueryable<TSource>

Uma sequência de valores a serem ordenados.

keySelector

Expression<Func<TSource,TKey>>

Uma função para extrair uma chave de um elemento.

comparer

IComparer<TKey>

Um IComparer<T> para comparar chaves.

Retornos

IOrderedQueryable<TSource>

Um IOrderedQueryable<T> cujos elementos são classificados de acordo com uma chave.

Exceções

ArgumentNullException

source, keySelector ou comparer é null.

Comentários

Esse método tem pelo menos um parâmetro do tipo Expression<TDelegate> cujo argumento de tipo é um dos Func<T,TResult> tipos. Para esses parâmetros, você pode passar uma expressão lambda e ela será compilada para um Expression<TDelegate>.

O OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) método gera um MethodCallExpression que representa chamar OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) a si mesmo como um método genérico construído. Em seguida, ele passa o MethodCallExpression para o CreateQuery<TElement>(Expression) método do IQueryProvider representado pela Provider propriedade do source parâmetro . O resultado da chamada CreateQuery<TElement>(Expression) é convertido em tipo IOrderedQueryable<T> e retornado.

O comportamento da consulta que ocorre como resultado da execução de uma árvore de expressão que representa a chamada OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) depende da implementação do tipo do source parâmetro. O comportamento esperado é que ele classifica os elementos de source com base na chave obtida invocando keySelector em cada elemento de source. O comparer parâmetro é usado para comparar chaves.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)

Origem:

Queryable.cs

Classifica os elementos de uma sequência em ordem crescente de acordo com uma chave.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderBy(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector);

public static System.Linq.IOrderedQueryable<TSource> OrderBy<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector);

static member OrderBy : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IQueryable(Of TSource), keySelector As Expression(Of Func(Of TSource, TKey))) As IOrderedQueryable(Of TSource)

Parâmetros de tipo

TSource

O tipo dos elementos de source.

TKey

O tipo da chave retornada pela função que é representada por keySelector.

Parâmetros

source

IQueryable<TSource>

Uma sequência de valores a serem ordenados.

keySelector

Expression<Func<TSource,TKey>>

Uma função para extrair uma chave de um elemento.

Retornos

IOrderedQueryable<TSource>

Um IOrderedQueryable<T> cujos elementos são classificados de acordo com uma chave.

Exceções

ArgumentNullException

source ou keySelector é null.

Exemplos

O exemplo de código a seguir demonstra como usar OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) para classificar os elementos de uma sequência.

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void OrderByEx1()
{
    Pet[] pets = { new Pet { Name="Barley", Age=8 },
                   new Pet { Name="Boots", Age=4 },
                   new Pet { Name="Whiskers", Age=1 } };

    // Sort the Pet objects in the array by Pet.Age.
    IEnumerable<Pet> query =
        pets.AsQueryable().OrderBy(pet => pet.Age);

    foreach (Pet pet in query)
        Console.WriteLine("{0} - {1}", pet.Name, pet.Age);
}

/*
    This code produces the following output:

    Whiskers - 1
    Boots - 4
    Barley - 8
*/

Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Shared Sub OrderByEx1()
    Dim pets() As Pet = {New Pet With {.Name = "Barley", .Age = 8}, _
                         New Pet With {.Name = "Boots", .Age = 4}, _
                         New Pet With {.Name = "Whiskers", .Age = 1}}

    ' Sort the Pet objects in the array by Pet.Age.
    Dim query As IEnumerable(Of Pet) = _
                pets.AsQueryable().OrderBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    For Each pet As Pet In query
        output.AppendLine(String.Format("{0} - {1}", pet.Name, pet.Age))
    Next

    ' Display the output.
    MsgBox(output.ToString())
End Sub

' This code produces the following output:

' Whiskers - 1
' Boots - 4
' Barley - 8

Comentários

Esse método tem pelo menos um parâmetro do tipo Expression<TDelegate> cujo argumento de tipo é um dos Func<T,TResult> tipos. Para esses parâmetros, você pode passar uma expressão lambda e ela será compilada para um Expression<TDelegate>.

O OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) método gera um MethodCallExpression que representa chamar OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) a si mesmo como um método genérico construído. Em seguida, ele passa o MethodCallExpression para o CreateQuery<TElement>(Expression) método do IQueryProvider representado pela Provider propriedade do source parâmetro . O resultado da chamada CreateQuery<TElement>(Expression) é convertido em tipo IOrderedQueryable<T> e retornado.

O comportamento da consulta que ocorre como resultado da execução de uma árvore de expressão que representa a chamada OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) depende da implementação do tipo do source parâmetro. O comportamento esperado é que ele classifica os elementos de source com base na chave obtida invocando keySelector em cada elemento de source.