Queryable.OrderBy メソッド

定義

名前空間:

System.Linq

アセンブリ:

System.Linq.Queryable.dll

シーケンスの要素を昇順に並べ替えます。

オーバーロード

OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)	指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。
OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)	シーケンスの要素をキーに従って昇順に並べ替えます。

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

ソース:

Queryable.cs

指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderBy(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ 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);

static member OrderBy : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IQueryable(Of TSource), keySelector As Expression(Of Func(Of TSource, TKey)), comparer As IComparer(Of TKey)) As IOrderedQueryable(Of TSource)

型パラメーター

TSource

source の要素の型。

TKey

keySelector で表される関数によって返されるキーの型。

パラメーター

source

IQueryable<TSource>

順序付ける値のシーケンス。

keySelector

Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。

comparer

IComparer<TKey>

キーを比較する IComparer<T>。

戻り値

IOrderedQueryable<TSource>

要素がキーに従って並べ替えられている IOrderedQueryable<T>。

例外

ArgumentNullException

source、keySelector、または comparer は、null です。

注釈

このメソッドには、型引数が型 Expression<TDelegate> の 1 つである型のパラメーターが少なくとも 1 つ Func<T,TResult> 含まれています。 これらのパラメーターでは、ラムダ式を渡すことができます。これは に 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>) 表す を生成します。 次に、 パラメーターの MethodCallExpressionCreateQuery<TElement>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。 呼び出し CreateQuery<TElement>(Expression) の結果は 型 IOrderedQueryable<T> にキャストされ、返されます。

呼び出し OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 のsource各要素で を呼び出すことによって取得されたキーに基づいて のsource要素をkeySelector並べ替えるということです。 パラメーターは comparer 、キーの比較に使用されます。

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

ソース:

Queryable.cs

シーケンスの要素をキーに従って昇順に並べ替えます。

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderBy(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector);

public static System.Linq.IOrderedQueryable<TSource> OrderBy<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector);

static member OrderBy : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IQueryable(Of TSource), keySelector As Expression(Of Func(Of TSource, TKey))) As IOrderedQueryable(Of TSource)

型パラメーター

TSource

source の要素の型。

TKey

keySelector で表される関数によって返されるキーの型。

パラメーター

source

IQueryable<TSource>

順序付ける値のシーケンス。

keySelector

Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。

戻り値

IOrderedQueryable<TSource>

要素がキーに従って並べ替えられている IOrderedQueryable<T>。

例外

ArgumentNullException

source または keySelector が null です。

例

次のコード例は、 を使用 OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) してシーケンスの要素を並べ替える方法を示しています。

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

注釈

このメソッドには、型引数が型 Expression<TDelegate> の 1 つである型のパラメーターが少なくとも 1 つ Func<T,TResult> 含まれています。 これらのパラメーターでは、ラムダ式を渡すことができます。これは に Expression<TDelegate>コンパイルされます。

メソッドは OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) 、 MethodCallExpression 構築されたジェネリック メソッドとして自身を呼び出すことを OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) 表す を生成します。 次に、 パラメーターの MethodCallExpressionCreateQuery<TElement>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。 呼び出し CreateQuery<TElement>(Expression) の結果は 型 IOrderedQueryable<T> にキャストされ、返されます。

呼び出し OrderBy<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 のsource各要素で を呼び出すことによって取得されたキーに基づいて のsource要素をkeySelector並べ替えるということです。