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 CommonFileQueryvar value = Windows.Storage.Search.CommonFileQuery.defaultQueryPublic Enum CommonFileQuery- 继承
-
CommonFileQuery
- 属性
Windows 要求
| 设备系列 |
Windows 10 (在 10.0.10240.0 中引入)
|
| API contract |
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)
|
字段
| DefaultQuery | 0 | 当前文件夹中的文件的浅表列表，类似于文件资源管理器提供的列表。 可以将此选项用于任何存储位置。 |
| OrderByDate | 5 | 文件夹及其子文件夹中文件的深层简单列表，按 System.ItemDate 排序。 只能对库中的文件夹或家庭组文件夹中使用此选项。 注意 System.ItemDate 是一个计算属性，它根据内容类型进行更改;例如，它映射到照片的 System.Photo.DateTaken 。 |
| OrderByMusicProperties | 3 | 文件夹及其子文件夹中文件的深层简单列表，按音乐属性排序。 只能对库中的文件夹或家庭组文件夹中使用此选项。 |
| OrderByName | 1 | 文件夹及其子文件夹中文件的深层简单列表，按 System.ItemNameDisplay 排序。 可以将此选项用于任何存储位置。 |
| OrderBySearchRank | 4 | 文件夹及其子文件夹中文件的深层简单列表，按 System.Search.Rank 和 System.DateModified 排序。 可以将此选项用于任何存储位置。 |
| OrderByTitle | 2 | 文件夹及其子文件夹中文件的深层简单列表，按 System.Title 排序。 只能对库中的文件夹或家庭组文件夹中使用此选项。 |
注解
调用 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 值是否可用于当前文件夹。
提示
对于查询用于对文件进行排序的 属性没有值的文件，通常从查询结果中排除。