Enumerable.OrderBy Método

Definição

Namespace:

System.Linq

Assembly:

System.Linq.dll

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

Sobrecargas

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

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)

Origem:

OrderBy.cs

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

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);

Parâmetros de tipo

TSource

O tipo dos elementos de source.

TKey

O tipo da chave retornada por keySelector.

Parâmetros

source

IEnumerable<TSource>

Uma sequência de valores a serem ordenados.

keySelector

Func<TSource,TKey>

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

Retornos

IOrderedEnumerable<TSource>

Um IOrderedEnumerable<TElement> 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>(IEnumerable<TSource>, Func<TSource,TKey>) para classificar os elementos de uma sequência.

C#

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 } };

    IEnumerable<Pet> query = pets.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
*/

Comentários

Esse método é implementado usando a execução adiada. O valor retornado imediato é um objeto que armazena todas as informações necessárias para executar a ação. A consulta representada por esse método não é executada até que o objeto seja enumerado chamando seu GetEnumerator método diretamente ou usando foreach em C# ou For Each no Visual Basic.

Para ordenar uma sequência pelos valores dos próprios elementos, especifique a função de identidade (x => x em C# ou Function(x) x no Visual Basic) para keySelector.

Dois métodos são definidos para estender o tipo IOrderedEnumerable<TElement>, que é o tipo de retorno desse método. Esses dois métodos, ou ThenBy seja, e ThenByDescending, permitem que você especifique critérios de classificação adicionais para classificar uma sequência. ThenBy e ThenByDescending também retornam um IOrderedEnumerable<TElement>, o que significa que qualquer número de chamadas consecutivas para ThenBy ou ThenByDescending pode ser feita.

Observação

Como IOrderedEnumerable<TElement> herda de IEnumerable<T>, você pode chamar OrderBy ou OrderByDescending nos resultados de uma chamada para OrderBy, OrderByDescendingThenBy ou ThenByDescending. Isso apresenta uma nova ordenação primária que ignora a ordenação estabelecida anteriormente.

Esse método compara as chaves usando o comparador Defaultpadrão .

Esse método executa uma classificação estável; ou seja, se as chaves de dois elementos forem iguais, a ordem dos elementos será preservada. Por outro lado, uma classificação instável não preserva a ordem dos elementos que têm a mesma chave.

Na sintaxe da expressão de consulta, uma orderby cláusula (C#) ou Order By (Visual Basic) é convertida em uma invocação de OrderBy.

Confira também

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
• Cláusula orderby (Referência de C#)
• Cláusula Order By (Visual Basic)

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)

Origem:

OrderBy.cs

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

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IComparer<TKey>? comparer);

Parâmetros de tipo

TSource

O tipo dos elementos de source.

TKey

O tipo da chave retornada por keySelector.

Parâmetros

source

IEnumerable<TSource>

Uma sequência de valores a serem ordenados.

keySelector

Func<TSource,TKey>

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

comparer

IComparer<TKey>

Um IComparer<T> para comparar chaves.

Retornos

IOrderedEnumerable<TSource>

Um IOrderedEnumerable<TElement> cujos elementos são classificados de acordo com uma chave.

Exceções

ArgumentNullException

source ou keySelector é null.

Comentários

Esse método é implementado usando a execução adiada. O valor retornado imediato é um objeto que armazena todas as informações necessárias para executar a ação. A consulta representada por esse método não é executada até que o objeto seja enumerado chamando seu GetEnumerator método diretamente ou usando foreach em C# ou For Each no Visual Basic.

Para ordenar uma sequência pelos valores dos próprios elementos, especifique a função de identidade (x => x em C# ou Function(x) x no Visual Basic) para keySelector.

Dois métodos são definidos para estender o tipo IOrderedEnumerable<TElement>, que é o tipo de retorno desse método. Esses dois métodos, ou ThenBy seja, e ThenByDescending, permitem que você especifique critérios de classificação adicionais para classificar uma sequência. ThenBy e ThenByDescending também retornam um IOrderedEnumerable<TElement>, o que significa que qualquer número de chamadas consecutivas para ThenBy ou ThenByDescending pode ser feita.

Observação

Como IOrderedEnumerable<TElement> herda de IEnumerable<T>, você pode chamar OrderBy ou OrderByDescending nos resultados de uma chamada para OrderBy, OrderByDescendingThenBy ou ThenByDescending. Isso apresenta uma nova ordenação primária que ignora a ordenação estabelecida anteriormente.

Se comparer for null, o comparador Default padrão será usado para comparar chaves.

Esse método executa uma classificação estável; ou seja, se as chaves de dois elementos forem iguais, a ordem dos elementos será preservada. Por outro lado, uma classificação instável não preserva a ordem dos elementos que têm a mesma chave.

Confira também

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)