Enumerable.OrderBy Méthode

Définition

Trie les éléments d'une séquence dans l'ordre croissant.

Surcharges

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

Trie les éléments d'une séquence dans l'ordre croissant selon une clé.

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

Trie les éléments d'une séquence dans l'ordre croissant à l'aide d'un comparateur spécifié.

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

Trie les éléments d'une séquence dans l'ordre croissant selon une clé.

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)

Paramètres de type

TSource

Le type des éléments de source.

TKey

Type de clé retournée par keySelector.

Paramètres

source
IEnumerable<TSource>

Séquence de valeurs à classer.

keySelector
Func<TSource,TKey>

Fonction permettant d'extraire une clé d'un élément.

Retours

IOrderedEnumerable<TSource>

IOrderedEnumerable<TElement> dont les éléments sont triés selon une clé.

Exceptions

source ou keySelector est null.

Exemples

L’exemple de code suivant montre comment utiliser OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) pour trier les éléments d’une séquence.

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

Remarques

Cette méthode est implémentée à l’aide de l’exécution différée. La valeur de retour immédiate est un objet qui stocke toutes les informations requises pour effectuer l’action. La requête représentée par cette méthode n’est pas exécutée tant que l’objet n’est pas énuméré soit en appelant sa GetEnumerator méthode directement, soit en utilisant foreach en Visual C# ou For Each dans Visual Basic.

pour trier une séquence selon les valeurs des éléments eux-mêmes, spécifiez la fonction d’identité ( x => x en Visual C# ou Function(x) x en Visual Basic) pour keySelector .

Deux méthodes sont définies pour étendre le type IOrderedEnumerable<TElement> , qui est le type de retour de cette méthode. Ces deux méthodes, à savoir ThenBy et ThenByDescending , vous permettent de spécifier des critères de tri supplémentaires pour trier une séquence. ThenBy et ThenByDescending retournent également un IOrderedEnumerable<TElement> , ce qui signifie que n’importe quel nombre d’appels consécutifs à ThenBy ou ThenByDescending peut être effectué.

Notes

Comme IOrderedEnumerable<TElement> hérite de IEnumerable<T> , vous pouvez appeler OrderBy ou OrderByDescending sur les résultats d’un appel à OrderBy , OrderByDescending ThenBy ou ThenByDescending . Cela introduit un nouveau classement principal qui ignore le classement précédemment établi.

Cette méthode compare les clés à l’aide du comparateur par défaut Default .

Cette méthode effectue un tri stable ; autrement dit, si les clés de deux éléments sont égales, l’ordre des éléments est préservé. En revanche, un tri instable ne conserve pas l’ordre des éléments qui ont la même clé.

dans la syntaxe d’expression de requête, une orderby clause (Visual C#) ou Order By (Visual Basic) se traduit par un appel de OrderBy .

Voir aussi

S’applique à

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

Trie les éléments d'une séquence dans l'ordre croissant à l'aide d'un comparateur spécifié.

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

Paramètres de type

TSource

Le type des éléments de source.

TKey

Type de clé retournée par keySelector.

Paramètres

source
IEnumerable<TSource>

Séquence de valeurs à classer.

keySelector
Func<TSource,TKey>

Fonction permettant d'extraire une clé d'un élément.

comparer
IComparer<TKey>

IComparer<T> pour comparer les clés.

Retours

IOrderedEnumerable<TSource>

IOrderedEnumerable<TElement> dont les éléments sont triés selon une clé.

Exceptions

source ou keySelector est null.

Remarques

Cette méthode est implémentée à l’aide de l’exécution différée. La valeur de retour immédiate est un objet qui stocke toutes les informations requises pour effectuer l’action. La requête représentée par cette méthode n’est pas exécutée tant que l’objet n’est pas énuméré soit en appelant sa GetEnumerator méthode directement, soit en utilisant foreach en Visual C# ou For Each dans Visual Basic.

pour trier une séquence selon les valeurs des éléments eux-mêmes, spécifiez la fonction d’identité ( x => x en Visual C# ou Function(x) x en Visual Basic) pour keySelector .

Deux méthodes sont définies pour étendre le type IOrderedEnumerable<TElement> , qui est le type de retour de cette méthode. Ces deux méthodes, à savoir ThenBy et ThenByDescending , vous permettent de spécifier des critères de tri supplémentaires pour trier une séquence. ThenBy et ThenByDescending retournent également un IOrderedEnumerable<TElement> , ce qui signifie que n’importe quel nombre d’appels consécutifs à ThenBy ou ThenByDescending peut être effectué.

Notes

Comme IOrderedEnumerable<TElement> hérite de IEnumerable<T> , vous pouvez appeler OrderBy ou OrderByDescending sur les résultats d’un appel à OrderBy , OrderByDescending ThenBy ou ThenByDescending . Cela introduit un nouveau classement principal qui ignore le classement précédemment établi.

Si comparer est null , le comparateur par défaut Default est utilisé pour comparer les clés.

Cette méthode effectue un tri stable ; autrement dit, si les clés de deux éléments sont égales, l’ordre des éléments est préservé. En revanche, un tri instable ne conserve pas l’ordre des éléments qui ont la même clé.

Voir aussi

S’applique à