CommonFileQuery 列舉
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
指定如何排序查詢結果中的檔案,並判斷查詢是否為淺層或深層。 深層查詢的查詢結果包括目前資料夾的所有子資料夾中的所有檔案,並根據指定的選項排序。
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
- 繼承
-
CommonFileQuery
- 屬性
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 值是否可用於目前資料夾。
提示
查詢用來排序檔案的屬性值沒有檔案的檔案通常會從查詢結果中排除。