CommonFolderQuery Перечисление

Определение

Пространство имен:

Windows.Storage.Search

Указывает, как группировать файлы в папки в результатах запроса и определить, является ли запрос неглубоким или глубоким. Результаты запроса для глубоких запросов включают все файлы во всех вложенных папках текущей папки, сгруппированных в папки в соответствии с указанным параметром.

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

Наследование

Enum

CommonFolderQuery

Атрибуты

ContractVersionAttribute

Требования к 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 каждого файла. Каждая папка будет представлять одного автора и содержать все файлы, вектор System.Author которых содержит этот автор. Если файл содержит несколько авторов, он может отображаться в нескольких результирующей папке. Этот параметр можно использовать только для папок в библиотеке или в папке HomeGroup.
GroupByComposer	105	Группирование файлов в виртуальные папки на основе свойства System.Music.Composer каждого файла. Каждая папка будет представлять одного композитора и содержит все файлы, вектор System.Music.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	Группирование файлов в виртуальные папки по рейтингу (1 звезда, 2 звезды и т. д.) на основе свойства System.Rating каждого файла. Каждая папка будет содержать все (и только) файлы с одинаковыми значениями для System.Rating. Этот параметр можно использовать только для папок в библиотеке или в папке HomeGroup.
GroupByTag	109	Группирование файлов в виртуальные папки на основе свойства System.Keywords каждого файла. Каждая папка будет представлять один тег и содержит все файлы, вектор System.Keywords которых содержит этот тег. Если файл содержит несколько тегов в векторе System.Keywords , он может отображаться в нескольких результирующей папке. Этот параметр можно использовать только для папок в библиотеке или в папке HomeGroup.
GroupByType	111	Группирование файлов в виртуальные папки по типу (например, документы Microsoft Word, текстовые файлы и т. д.) на основе свойства System.ItemTypeText каждого файла. Этот параметр можно использовать только для папок в библиотеке или в папке HomeGroup.
GroupByYear	100	Группируйте файлы в виртуальные папки по годам на основе свойства System.ItemDate каждого файла. Каждая папка будет содержать все (и только) файлы с значениями System.ItemDate в течение одного года. Этот параметр можно использовать только для папок в библиотеке или в папке HomeGroup.

Комментарии

Используйте значение из перечисления CommonFolderQuery при вызове одного из следующих методов класса StorageFolder . Примеры использования значений из перечисления CommonFolderQuery см. в разделах для этих методов.

• CreateFolderQuery(CommonFolderQuery)
• CreateFolderQueryWithOptions. Создайте экземпляр QueryOptions с помощью конструктора QueryOptions(CommonFolderQuery).
• CreateItemQueryWithOptions. Создайте экземпляр QueryOptions с помощью конструктора QueryOptions(CommonFolderQuery).
• GetFoldersAsync(CommonFolderQuery)
• GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Эти методы используют значение перечисления CommonFolderQuery для инициализации параметров DateStackOption, FolderDepth, IndexerOption и SortOrder запроса.

Вызовите метод StorageFolder.IsCommonFolderQuerySupported , чтобы определить, доступно ли значение CommonFolderQuery для текущей папки.

Совет

Если запрос группирует файлы в виртуальные папки на основе свойства, которое может иметь несколько значений (например, System.Author), определенный файл может отображаться в нескольких виртуальных папках, так как каждая папка представляет одно из нескольких значений.

Файлы, не имеющие значения для свойства, которое запрос использует для группирования файлов, обычно исключаются из результатов запроса.

См. также раздел

• QueryOptions(CommonFolderQuery)
• StorageFolder
• Пример перечисления папок (Windows 10)