CommonFileQuery 列挙型

定義

名前空間:

Windows.Storage.Search

クエリ結果内のファイルを並べ替える方法を指定し、クエリが浅いか深いかを判断します。 詳細クエリのクエリ結果には、指定したオプションに従って並べ替えられた、現在のフォルダーのすべてのサブフォルダー内のすべてのファイルが含まれます。

public enum class CommonFileQuery

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class CommonFileQuery

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum CommonFileQuery

var value = Windows.Storage.Search.CommonFileQuery.defaultQuery

Public Enum CommonFileQuery

継承

Enum

CommonFileQuery

属性

ContractVersionAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

フィールド

DefaultQuery	0	エクスプローラーが提供するリストと同様に、現在のフォルダー内のファイルのシャロー リスト。 このオプションは、任意の保存場所に使用できます。
OrderByDate	5	System.ItemDate で並べ替えられたフォルダーとそのサブフォルダー内のファイルの詳細でフラットな一覧。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 注意 System.ItemDate は、コンテンツ タイプに基づいて変更される計算プロパティです。たとえば、写真の場合は System.Photo.DateTaken にマップされます。
OrderByMusicProperties	3	音楽プロパティで並べ替えられた、フォルダーとそのサブフォルダー内のファイルの詳細でフラットなリスト。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。
OrderByName	1	System.ItemNameDisplay で並べ替えられたフォルダーとそのサブフォルダー内のファイルの詳細でフラットなリスト。 このオプションは、任意の保存場所に使用できます。
OrderBySearchRank	4	System.Search.Rank の後に System.DateModified で並べ替えられた、フォルダーとそのサブフォルダー内のファイルの詳細でフラットな一覧。 このオプションは、任意の保存場所に使用できます。
OrderByTitle	2	System.Title で並べ替えられたフォルダーとそのサブフォルダー内のファイルの詳細でフラットな一覧。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。

注釈

StorageFolder クラスの次のいずれかのメソッドを呼び出すときは、CommonFileQuery 列挙の値を使用します。 CommonFileQuery 列挙体の値を使用する例については、これらのメソッドのトピックを参照してください。

• CreateFileQuery(CommonFileQuery)
• CreateFileQueryWithOptions。 QueryOptions(CommonFileQuery, IIterable(String)) コンストラクターを使用して QueryOptions をインスタンス化します。
• CreateItemQueryWithOptions。 QueryOptions(CommonFileQuery, IIterable(String)) コンストラクターを使用して QueryOptions をインスタンス化します。
• GetFilesAsync(CommonFileQuery)
• GetFilesAsync(CommonFileQuery, UInt32, UInt32)

これらのメソッドは、CommonFileQuery 列挙の値を使用して、クエリの FolderDepth、 IndexerOption、および SortOrder オプションを初期化します。

StorageFolder.IsCommonFileQuerySupported メソッドを呼び出して、使用する CommonFileQuery 値が現在のフォルダーで使用できるかどうかを判断します。

ヒント

クエリがファイルの並べ替えに使用する プロパティの値を持たないファイルは、通常、クエリ結果から除外されます。

こちらもご覧ください

• フォルダー列挙のサンプル (Windows 10)