Queryable.OrderBy Method

定義

シーケンスの要素を昇順に並べ替えます。 Sorts the elements of a sequence in ascending order.

オーバーロード

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)

指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。 Sorts the elements of a sequence in ascending order by using a specified comparer.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)

シーケンスの要素をキーに従って昇順に並べ替えます。 Sorts the elements of a sequence in ascending order according to a key.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)

指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。 Sorts the elements of a sequence in ascending order by using a specified comparer.

public static System.Linq.IOrderedQueryable<TSource> OrderBy<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector, System.Collections.Generic.IComparer<TKey> comparer);
型パラメーター
TSource

要素の型ソースします。 The type of the elements of source.

TKey

表される関数によって返されるキーの種類keySelectorします。 The type of the key returned by the function that is represented by keySelector.

パラメーター
source
IQueryable<TSource>

順序付ける値のシーケンス。 A sequence of values to order.

keySelector
Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。 A function to extract a key from an element.

comparer
IComparer<TKey>

キーを比較する IComparer<T> An IComparer<T> to compare keys.

戻り値

要素がキーに従って並べ替えられている IOrderedQueryable<T> An IOrderedQueryable<T> whose elements are sorted according to a key.

例外

sourcekeySelector、または comparer は、null です。 source or keySelector or comparer is null.

注釈

このメソッドは、少なくとも 1 つのパラメーター型のExpression<TDelegate>型引数は、のいずれか、Func<T,TResult>型。This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T,TResult> types. ラムダ式で、これらのパラメーターを渡すことができますにコンパイルされると、Expression<TDelegate>します。For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)メソッドを生成、MethodCallExpression呼び出しを表すOrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)として構築されたジェネリック メソッド自体。The OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) method generates a MethodCallExpression that represents calling OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) itself as a constructed generic method. これは、後、渡します、MethodCallExpressionCreateQuery<TElement>(Expression)のメソッド、IQueryProviderによって表される、Providerのプロパティ、sourceパラメーター。It then passes the MethodCallExpression to the CreateQuery<TElement>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter. 呼び出しの結果CreateQuery<TElement>(Expression)型にキャストはIOrderedQueryable<T>返されるとします。The result of calling CreateQuery<TElement>(Expression) is cast to type IOrderedQueryable<T> and returned.

呼び出し元を表す式ツリーを実行した結果として発生するクエリの動作OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)の型の実装によって異なります、sourceパラメーター。The query behavior that occurs as a result of executing an expression tree that represents calling OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) depends on the implementation of the type of the source parameter. 要素を並べ替えますが想定される動作は、sourceを呼び出すことによって取得したキーに基づくkeySelectorの各要素に対してsourceします。The expected behavior is that it sorts the elements of source based on the key obtained by invoking keySelector on each element of source. comparerパラメーターは、キーの比較に使用します。The comparer parameter is used to compare keys.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)

シーケンスの要素をキーに従って昇順に並べ替えます。 Sorts the elements of a sequence in ascending order according to a key.

public static System.Linq.IOrderedQueryable<TSource> OrderBy<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector);
型パラメーター
TSource

要素の型ソースします。 The type of the elements of source.

TKey

表される関数によって返されるキーの種類keySelectorします。 The type of the key returned by the function that is represented by keySelector.

パラメーター
source
IQueryable<TSource>

順序付ける値のシーケンス。 A sequence of values to order.

keySelector
Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。 A function to extract a key from an element.

戻り値

要素がキーに従って並べ替えられている IOrderedQueryable<T> An IOrderedQueryable<T> whose elements are sorted according to a key.

例外

source または keySelectornull です。 source or keySelector is null.

次のコード例は、使用する方法を示しますOrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)シーケンスの要素を並べ替えます。The following code example demonstrates how to use OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) to sort the elements of a sequence.

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

    // Sort the Pet objects in the array by Pet.Age.
    IEnumerable<Pet> query =
        pets.AsQueryable().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

Shared Sub OrderByEx1()
    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}}

    ' Sort the Pet objects in the array by Pet.Age.
    Dim query As IEnumerable(Of Pet) = _
                pets.AsQueryable().OrderBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    For Each pet As Pet In query
        output.AppendLine(String.Format("{0} - {1}", pet.Name, pet.Age))
    Next

    ' Display the output.
    MsgBox(output.ToString())
End Sub

' This code produces the following output:

' Whiskers - 1
' Boots - 4
' Barley - 8

注釈

このメソッドは、少なくとも 1 つのパラメーター型のExpression<TDelegate>型引数は、のいずれか、Func<T,TResult>型。This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T,TResult> types. ラムダ式で、これらのパラメーターを渡すことができますにコンパイルされると、Expression<TDelegate>します。For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)メソッドを生成、MethodCallExpression呼び出しを表すOrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)として構築されたジェネリック メソッド自体。The OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) method generates a MethodCallExpression that represents calling OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) itself as a constructed generic method. これは、後、渡します、MethodCallExpressionCreateQuery<TElement>(Expression)のメソッド、IQueryProviderによって表される、Providerのプロパティ、sourceパラメーター。It then passes the MethodCallExpression to the CreateQuery<TElement>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter. 呼び出しの結果CreateQuery<TElement>(Expression)型にキャストはIOrderedQueryable<T>返されるとします。The result of calling CreateQuery<TElement>(Expression) is cast to type IOrderedQueryable<T> and returned.

呼び出し元を表す式ツリーを実行した結果として発生するクエリの動作OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)の型の実装によって異なります、sourceパラメーター。The query behavior that occurs as a result of executing an expression tree that represents calling OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) depends on the implementation of the type of the source parameter. 要素を並べ替えますが想定される動作は、sourceを呼び出すことによって取得したキーに基づくkeySelectorの各要素に対してsourceします。The expected behavior is that it sorts the elements of source based on the key obtained by invoking keySelector on each element of source.

適用対象