CommonFolderQuery 列挙型
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
クエリ結果内のフォルダーにファイルをグループ化する方法を指定し、クエリが浅いか深いかを決定します。 詳細クエリのクエリ結果には、指定したオプションに従ってフォルダーにグループ化された、現在のフォルダーのすべてのサブフォルダー内のすべてのファイルが含まれます。
public enum class CommonFolderQuery
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class CommonFolderQuery
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum CommonFolderQuery
var value = Windows.Storage.Search.CommonFolderQuery.defaultQuery
Public Enum CommonFolderQuery
- 継承
-
CommonFolderQuery
- 属性
Windows の要件
デバイス ファミリ |
Windows 10 (10.0.10240.0 で導入)
|
API contract |
Windows.Foundation.UniversalApiContract (v1.0 で導入)
|
フィールド
DefaultQuery | 0 | エクスプローラーが提供するビューと同様に、現在のフォルダー内のフォルダーのシャロー リスト。 このオプションは、任意の保存場所に使用できます。 |
GroupByAlbum | 103 | 各ファイルの System.Music.AlbumTitle プロパティに基づいて、ファイルを年単位で仮想フォルダーにグループ化します。 各フォルダーには、 System.Music.AlbumTitle と同じ値を持つすべての (およびのみ) ファイルが含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByAlbumArtist | 104 | 各ファイルの System.Music.AlbumArtist プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーには、 System.Music.AlbumArtist と同じ値を持つすべてのファイル (およびのみ) が含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByArtist | 102 | 各ファイルの System.Music.Artist プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーには、 System.Music.Artist と同じ値を持つすべてのファイル (およびのみ) が含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByAuthor | 110 | 各ファイルの System.Author プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーは 1 人の作成者を表し、 System.Author ベクターにその作成者が含まれるすべてのファイルが含まれます。 ファイルに複数の作成者が一覧表示されている場合は、結果として得られる複数のフォルダーにファイルが表示される可能性があります。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByComposer | 105 | 各ファイルの System.Music.Composer プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーは 1 つのコンポーザーを表し、 System.Music.Composer ベクターにその Composer が含まれるすべてのファイルが含まれます。 ファイルに複数のコンポーザーが一覧表示されている場合は、結果として得られる複数のフォルダーにファイルが表示されることがあります。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByGenre | 106 | 各ファイルの System.Music.Genre プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーには、 System.Music.Genre に同じ値を持つすべてのファイル (およびのみ) が含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByMonth | 101 | 各ファイルの System.ItemDate プロパティに基づいて、月単位でファイルを仮想フォルダーにグループ化します。 各フォルダーには、同じ月内に System.ItemDate の値を持つすべての (および唯一の) ファイルが含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByPublishedYear | 107 | 各ファイルの System.Media.Year プロパティに基づいて、ファイルを年単位で仮想フォルダーにグループ化します。 各フォルダーには、同じ年内に System.Media.Year の値を持つすべての (および唯一の) ファイルが含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByRating | 108 | 各ファイルの System.Rating プロパティに基づいて、ファイルを評価 (1 star、2 つ星など) で仮想フォルダーにグループ化します。 各フォルダーには、 System.Rating に同じ値を持つすべての (および唯一の) ファイルが含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByTag | 109 | 各ファイルの System.Keywords プロパティに基づいて、ファイルを仮想フォルダーにグループ化します。 各フォルダーは 1 つのタグを表し、 System.Keywords ベクターにそのタグが含まれるすべてのファイルが含まれます。 ファイルに System.Keywords ベクター内の複数のタグが一覧表示されている場合は、結果として得られる複数のフォルダーに表示される可能性があります。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByType | 111 | 各ファイルの System.ItemTypeText プロパティに基づいて、ファイルを種類 (Microsoft Word ドキュメント、テキスト ファイルなど) ごとに仮想フォルダーにグループ化します。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
GroupByYear | 100 | 各ファイルの System.ItemDate プロパティに基づいて、ファイルを年単位で仮想フォルダーにグループ化します。 各フォルダーには、同じ年内に System.ItemDate の値を持つすべての (および唯一の) ファイルが含まれます。 このオプションは、ライブラリまたは HomeGroup フォルダー内のフォルダーに対してのみ使用できます。 |
注釈
StorageFolder クラスの次のいずれかのメソッドを呼び出すときは、 CommonFolderQuery 列挙の値を使用します。 CommonFolderQuery 列挙体の値を使用する例については、これらのメソッドのトピックを参照してください。
- CreateFolderQuery(CommonFolderQuery)
- CreateFolderQueryWithOptions。 QueryOptions(CommonFolderQuery) コンストラクターを使用して QueryOptions をインスタンス化します。
- CreateItemQueryWithOptions。 QueryOptions(CommonFolderQuery) コンストラクターを使用して QueryOptions をインスタンス化します。
- GetFoldersAsync(CommonFolderQuery)
- GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)
これらのメソッドは、CommonFolderQuery 列挙の値を使用して、クエリの DateStackOption、 FolderDepth、 IndexerOption、および SortOrder オプションを初期化します。
StorageFolder.IsCommonFolderQuerySupported メソッドを呼び出して、使用する CommonFolderQuery 値が現在のフォルダーで使用できるかどうかを判断します。
ヒント
クエリで複数の値を持つプロパティ ( System.Author など) に基づいてファイルを仮想フォルダーにグループ化すると、各フォルダーが複数の値の 1 つを表しているため、特定のファイルが複数の仮想フォルダーに表示されることがあります。
クエリがファイルのグループ化に使用するプロパティの値を持たないファイルは、通常、クエリ結果から除外されます。