Enumerable.OrderBy Método

Definição

Espaço de Nomes:: System.Linq

Assemblagens:: System.Core.dll, System.Linq.dll

Assemblagem:: System.Core.dll

Assemblagem:: System.Linq.dll

Assemblagem:: netstandard.dll

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

Ordena os elementos de uma sequência por ordem crescente.

Sobrecargas

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

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

Ordena os elementos de uma sequência por ordem crescente de acordo com uma chave.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderBy(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector);

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

static member OrderBy : seq<'Source> * Func<'Source, 'Key> -> System.Linq.IOrderedEnumerable<'Source>

<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey)) As IOrderedEnumerable(Of TSource)

Parâmetros de Tipo Genérico

TSource

O tipo dos elementos de source.

TKey

O tipo da chave devolvido por keySelector.

Parâmetros

source: IEnumerable<TSource>

Uma sequência de valores por ordem.

keySelector: Func<TSource,TKey>

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

Devoluções

IOrderedEnumerable<TSource>

E IOrderedEnumerable<TElement> cujos elementos são ordenados de acordo com uma chave.

Exceções

ArgumentNullException

source ou keySelector é null.

Exemplos

O exemplo de código seguinte demonstra como usar OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) para ordenar 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 } };

    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
*/

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

Sub OrderByEx1()
    ' Create an array of Pet objects.
    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}}

    ' Order the Pet objects by their Age property.
    Dim query As IEnumerable(Of Pet) =
    pets.OrderBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    For Each pt As Pet In query
        output.AppendLine(pt.Name & " - " & pt.Age)
    Next

    ' Display the output.
    Console.WriteLine(output.ToString())
End Sub

' This code produces the following output:
'
' Whiskers - 1
' Boots - 4
' Barley - 8

Observações

Este método é implementado através da execução diferida. O valor de retorno imediato é um objeto que armazena toda a informação necessária para realizar a ação. A consulta representada por este método não é executada até que o objeto seja enumerado, seja chamando diretamente o seu método GetEnumerator ou usando foreach em C# ou For Each em Visual Basic.

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

São definidos dois métodos para estender o tipo IOrderedEnumerable<TElement>, que é o tipo de retorno deste método. Estes dois métodos, nomeadamente ThenBy e ThenByDescending, permitem-lhe especificar critérios adicionais de ordenação para ordenar uma sequência. ThenBy e ThenByDescending também retornam um IOrderedEnumerable<TElement>, o que significa qualquer número de chamadas consecutivas para ThenBy ou ThenByDescending podem ser feitas.

Note

Como IOrderedEnumerable<TElement> herda de IEnumerable<T>, pode chamar OrderBy ou OrderByDescending nos resultados de uma chamada para OrderBy, OrderByDescending, ThenBy ou ThenByDescending. Fazer isto introduz uma nova ordem primária que ignora a ordem previamente estabelecida.

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

Este método executa uma ordenação estável; isto é, se as chaves de dois elementos forem iguais, a ordem dos elementos é preservada. Em contraste, uma ordenação instável não preserva a ordem dos elementos que têm a mesma chave.

Na sintaxe da expressão de consulta, uma cláusula orderby (C#) ou Order By (Visual Basic) traduz-se numa invocação de OrderBy.

Ver também

Aplica-se a

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

Ordena os elementos de uma sequência por ordem crescente usando um comparador especificado.

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

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

static member OrderBy : seq<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedEnumerable<'Source>

<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), comparer As IComparer(Of TKey)) As IOrderedEnumerable(Of TSource)