Enumerable.OrderBy Méthode

Définition

Espace de noms:: System.Linq

Assemblys:: System.Core.dll, System.Linq.dll

Assembly:: System.Core.dll

Assembly:: System.Linq.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

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

Surcharges

Nom	Description
OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Trie les éléments d’une séquence dans l’ordre croissant en fonction d’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 en fonction d’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

Type des éléments de source.

TKey

Type de la 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>

Dont IOrderedEnumerable<TElement> les éléments sont triés en fonction d’une clé.

Exceptions

ArgumentNullException

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é en appelant directement sa méthode GetEnumerator ou en utilisant foreach en C# ou For Each dans Visual Basic.

Pour classer une séquence par les valeurs des éléments eux-mêmes, spécifiez la fonction d’identité (x => x en C# ou Function(x) x dans 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 retourne également un IOrderedEnumerable<TElement>, ce qui signifie que n’importe quel nombre d’appels consécutifs vers ThenBy ou ThenByDescending peut être effectué.

Note

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. Cette opération introduit un nouvel ordre principal qui ignore l’ordre établi précédemment.

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

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 conservé. En revanche, un tri instable ne conserve pas l’ordre des éléments qui ont la même clé.

Dans la syntaxe des expressions de requête, une clause orderby (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);

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)