Enumerable.OrderBy 方法

定義

命名空間:

System.Linq

組件:

System.Linq.dll

依遞增順序排序序列中的項目。

多載

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	依據索引鍵，按遞增順序排序序列中的項目。
OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)	使用指定的比較子，依遞增順序排序序列中的項目。

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

來源:

OrderBy.cs

依據索引鍵，按遞增順序排序序列中的項目。

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);

類型參數

TSource

source 項目的類型。

TKey

keySelector 所傳回之索引鍵的型別。

參數

source

IEnumerable<TSource>

要排序的值序列。

keySelector

Func<TSource,TKey>

用來從項目擷取索引鍵的函式。

傳回

IOrderedEnumerable<TSource>

依據索引鍵排序其項目的 IOrderedEnumerable<TElement>。

例外狀況

ArgumentNullException

source 或 keySelector 為 null。

範例

下列程式代碼範例示範如何使用 OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) 來排序序列的專案。

C#

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
*/

備註

這個方法是使用延後執行來實作。 立即傳回值是一個物件，會儲存執行動作所需的所有資訊。 除非直接呼叫其 GetEnumerator 方法或在 C# 或 foreachFor Each Visual Basic 中使用 來列舉對象，否則不會執行這個方法所代表的查詢。

若要依元素本身的值排序序列，請在 C# 或 Visual Basic) 中指定識別函式 (x => xkeySelector。Function(x) x

定義兩種方法來擴充類型 IOrderedEnumerable<TElement>，這是這個方法的傳回型別。 這兩種方法，也就是 ThenBy 和 ThenByDescending，可讓您指定排序序列的其他排序準則。 ThenBy和 ThenByDescending 也會傳回 IOrderedEnumerable<TElement>，這表示可以對 或 ThenByDescending 進行任意數目的連續呼叫ThenBy。

備註

因為 IOrderedEnumerable<TElement> 繼承自 IEnumerable<T>，所以您可以在呼叫 、 OrderByDescendingThenBy 或 的結果上呼叫 OrderByDescendingOrderByOrderBy或 。ThenByDescending 這麼做引進了忽略先前建立順序的新主要順序。

這個方法會使用預設比較子 Default來比較索引鍵。

這個方法會執行穩定排序;也就是說，如果兩個元素的索引鍵相等，則會保留元素的順序。 相反地，不穩定的排序不會保留具有相同索引鍵的項目順序。

在查詢表達式語法中， orderby (C#) 或 Order By (Visual Basic) 子句會轉譯為 的 OrderBy調用。

另請參閱

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
• orderby 子句 (C# 參考)
• Order By 子句 (Visual Basic)

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

來源:

OrderBy.cs

使用指定的比較子，依遞增順序排序序列中的項目。

C#

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

類型參數

TSource

source 項目的類型。

TKey

keySelector 所傳回之索引鍵的型別。

參數

source

IEnumerable<TSource>

要排序的值序列。

keySelector

Func<TSource,TKey>

用來從項目擷取索引鍵的函式。

comparer

IComparer<TKey>

用來比較金鑰的 IComparer<T>。

傳回

IOrderedEnumerable<TSource>

依據索引鍵排序其項目的 IOrderedEnumerable<TElement>。

例外狀況

ArgumentNullException

source 或 keySelector 為 null。

備註

這個方法是使用延後執行來實作。 立即傳回值是一個物件，會儲存執行動作所需的所有資訊。 除非直接呼叫其 GetEnumerator 方法或在 C# 或 foreachFor Each Visual Basic 中使用 來列舉對象，否則不會執行這個方法所代表的查詢。

若要依元素本身的值排序序列，請在 C# 或 Visual Basic) 中指定識別函式 (x => xkeySelector。Function(x) x

定義兩種方法來擴充類型 IOrderedEnumerable<TElement>，這是這個方法的傳回型別。 這兩種方法，也就是 ThenBy 和 ThenByDescending，可讓您指定排序序列的其他排序準則。 ThenBy和 ThenByDescending 也會傳回 IOrderedEnumerable<TElement>，這表示可以對 或 ThenByDescending 進行任意數目的連續呼叫ThenBy。

備註

因為 IOrderedEnumerable<TElement> 繼承自 IEnumerable<T>，所以您可以在呼叫 、 OrderByDescendingThenBy 或 的結果上呼叫 OrderByDescendingOrderByOrderBy或 。ThenByDescending 這麼做引進了忽略先前建立順序的新主要順序。

如果 為 comparernull，則會使用預設比較子 Default 來比較索引鍵。

這個方法會執行穩定排序;也就是說，如果兩個元素的索引鍵相等，則會保留元素的順序。 相反地，不穩定的排序不會保留具有相同索引鍵的項目順序。

另請參閱

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)