Enumerable.OrderBy Método

  • Referencia

Definición

Espacio de nombres:
System.Linq
Ensamblado:
System.Linq.dll
Ensamblado:
System.Core.dll
Ensamblado:
netstandard.dll

Ordena de manera ascendente los elementos de una secuencia.

Sobrecargas

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

Ordena de manera ascendente los elementos de una secuencia en función de una clave.
OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)

Ordena de manera ascendente los elementos de una secuencia utilizando un comparador especificado.

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

Source:
OrderBy.cs
Source:
OrderBy.cs
Source:
OrderBy.cs

Ordena de manera ascendente los elementos de una secuencia en función de una clave.

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

TSource

Tipo de los elementos de source.

TKey

Tipo de la clave devuelta por keySelector.

Parámetros

source
IEnumerable<TSource>

Secuencia de valores que se va a ordenar.

keySelector
Func<TSource,TKey>

Función para extraer una clave a partir de un elemento.

Devoluciones

IOrderedEnumerable<TSource>

Una interfaz IOrderedEnumerable<TElement> cuyos elementos se ordenan con arreglo a una clave.

Excepciones

ArgumentNullException

source o keySelector es null.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) para ordenar los elementos de una secuencia.

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

Comentarios

Este método se implementa mediante la ejecución diferida. El valor devuelto inmediato es un objeto que almacena toda la información necesaria para realizar la acción. La consulta representada por este método no se ejecuta hasta que el objeto se enumera llamando directamente a su GetEnumerator método o mediante foreach en C# o For Each en Visual Basic.

Para ordenar una secuencia por los valores de los propios elementos, especifique la función de identidad (x => x en C# o Function(x) x en Visual Basic) para keySelector.

Se definen dos métodos para extender el tipo IOrderedEnumerable<TElement>, que es el tipo de valor devuelto de este método. Estos dos métodos, a saber ThenBy , y ThenByDescending, permiten especificar criterios de ordenación adicionales para ordenar una secuencia. ThenBy y ThenByDescending también devuelven , IOrderedEnumerable<TElement>lo que significa que se puede realizar cualquier número de llamadas consecutivas a ThenBy o ThenByDescending .

Nota

Dado que IOrderedEnumerable<TElement> hereda de IEnumerable<T>, puede llamar a OrderBy o OrderByDescending en los resultados de una llamada a OrderBy, ThenByOrderByDescendingo ThenByDescending. Esto introduce una nueva ordenación principal que omite la ordenación establecida anteriormente.

Este método compara las claves mediante el comparador Defaultpredeterminado .

Este método realiza una ordenación estable; es decir, si las claves de dos elementos son iguales, se conserva el orden de los elementos. Por el contrario, una ordenación inestable no conserva el orden de los elementos que tienen la misma clave.

En la sintaxis de expresión de consulta, una orderby cláusula (C#) o Order By (Visual Basic) se traduce en una invocación de OrderBy.

Consulte también

Se aplica a

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

Source:
OrderBy.cs
Source:
OrderBy.cs
Source:
OrderBy.cs

Ordena de manera ascendente los elementos de una secuencia utilizando un 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);
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)

Parámetros de tipo

TSource

Tipo de los elementos de source.

TKey

Tipo de la clave devuelta por keySelector.

Parámetros

source
IEnumerable<TSource>

Secuencia de valores que se va a ordenar.

keySelector
Func<TSource,TKey>

Función para extraer una clave a partir de un elemento.

comparer
IComparer<TKey>

IComparer<T> para comparar claves.

Devoluciones

IOrderedEnumerable<TSource>

Una interfaz IOrderedEnumerable<TElement> cuyos elementos se ordenan con arreglo a una clave.

Excepciones

ArgumentNullException

source o keySelector es null.

Comentarios

Este método se implementa mediante la ejecución diferida. El valor devuelto inmediato es un objeto que almacena toda la información necesaria para realizar la acción. La consulta representada por este método no se ejecuta hasta que el objeto se enumera llamando directamente a su GetEnumerator método o mediante foreach en C# o For Each en Visual Basic.

Para ordenar una secuencia por los valores de los propios elementos, especifique la función de identidad (x => x en C# o Function(x) x en Visual Basic) para keySelector.

Se definen dos métodos para extender el tipo IOrderedEnumerable<TElement>, que es el tipo de valor devuelto de este método. Estos dos métodos, a saber ThenBy , y ThenByDescending, permiten especificar criterios de ordenación adicionales para ordenar una secuencia. ThenBy y ThenByDescending también devuelven , IOrderedEnumerable<TElement>lo que significa que se puede realizar cualquier número de llamadas consecutivas a ThenBy o ThenByDescending .

Nota

Dado que IOrderedEnumerable<TElement> hereda de IEnumerable<T>, puede llamar a OrderBy o OrderByDescending en los resultados de una llamada a OrderBy, ThenByOrderByDescendingo ThenByDescending. Esto introduce una nueva ordenación principal que omite la ordenación establecida anteriormente.

Si comparer es null, el comparador Default predeterminado se usa para comparar claves.

Este método realiza una ordenación estable; es decir, si las claves de dos elementos son iguales, se conserva el orden de los elementos. Por el contrario, una ordenación inestable no conserva el orden de los elementos que tienen la misma clave.

Consulte también

Se aplica a