CommonFolderQuery Énumération

Définition

Espace de noms:

Windows.Storage.Search

Spécifie comment regrouper des fichiers dans des dossiers dans les résultats de la requête et détermine si la requête est superficielle ou profonde. Les résultats des requêtes approfondies incluent tous les fichiers de tous les sous-dossiers du dossier actif, regroupés en dossiers selon l’option spécifiée.

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

Héritage

Enum

CommonFolderQuery

Attributs

ContractVersionAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Champs

DefaultQuery	0	Liste superficielle des dossiers dans le dossier actif, similaire à l’affichage fourni par Explorateur de fichiers. Vous pouvez utiliser cette option pour n’importe quel emplacement de stockage.
GroupByAlbum	103	Regroupez les fichiers dans des dossiers virtuels par année en fonction de la propriété System.Music.AlbumTitle de chaque fichier. Chaque dossier contiendra tous les fichiers (et uniquement) avec des valeurs identiques pour System.Music.AlbumTitle. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByAlbumArtist	104	Regroupez les fichiers dans des dossiers virtuels en fonction de la propriété System.Music.AlbumArtist de chaque fichier. Chaque dossier contiendra tous les fichiers (et uniquement) avec des valeurs identiques pour System.Music.AlbumArtist. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByArtist	102	Regroupez les fichiers dans des dossiers virtuels en fonction de la propriété System.Music.Artist de chaque fichier. Chaque dossier contient tous (et uniquement) les fichiers avec des valeurs identiques pour System.Music.Artist. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByAuthor	110	Regroupez des fichiers dans des dossiers virtuels en fonction de la propriété System.Author de chaque fichier. Chaque dossier représente un auteur et contient tous les fichiers dont le vecteur System.Author contient cet auteur. Si un fichier répertorie plusieurs auteurs, il peut apparaître dans plusieurs dossiers résultants. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByComposer	105	Regroupez les fichiers dans des dossiers virtuels en fonction de la propriété System.Music.Composer de chaque fichier. Chaque dossier représente un compositeur et contient tous les fichiers dont le vecteur System.Music.Composer contient ce compositeur. Si un fichier répertorie plusieurs compositeurs, il peut apparaître dans plusieurs dossiers résultants. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByGenre	106	Regroupez les fichiers dans des dossiers virtuels en fonction de la propriété System.Music.Genre de chaque fichier. Chaque dossier contient tous (et uniquement) les fichiers avec des valeurs identiques pour System.Music.Genre. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByMonth	101	Regroupez des fichiers dans des dossiers virtuels par mois en fonction de la propriété System.ItemDate de chaque fichier. Chaque dossier contient tous (et uniquement) les fichiers qui ont des valeurs pour System.ItemDate au cours du même mois. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByPublishedYear	107	Regroupez les fichiers dans des dossiers virtuels par année en fonction de la propriété System.Media.Year de chaque fichier. Chaque dossier contient tous (et uniquement) les fichiers qui ont des valeurs pour System.Media.Year au cours de la même année. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByRating	108	Regroupez les fichiers dans des dossiers virtuels par évaluation (1 star, 2 étoiles, etc.) en fonction de la propriété System.Rating de chaque fichier. Chaque dossier contient tous (et uniquement) les fichiers avec des valeurs identiques pour System.Rating. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByTag	109	Regroupez des fichiers dans des dossiers virtuels en fonction de la propriété System.Keywords de chaque fichier. Chaque dossier représente une balise et contient tous les fichiers dont le vecteur System.Keywords contient cette balise. Si un fichier répertorie plusieurs balises dans son vecteur System.Keywords , il peut apparaître dans plusieurs dossiers résultants. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByType	111	Regroupez les fichiers dans des dossiers virtuels par type (par exemple, Microsoft Word documents, fichiers texte, etc.) en fonction de la propriété System.ItemTypeText de chaque fichier. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
GroupByYear	100	Regroupez les fichiers dans des dossiers virtuels par année en fonction de la propriété System.ItemDate de chaque fichier. Chaque dossier contiendra tous (et uniquement) les fichiers qui ont des valeurs pour System.ItemDate au cours de la même année. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.

Remarques

Utilisez une valeur de l’énumération CommonFolderQuery lorsque vous appelez l’une des méthodes suivantes de la classe StorageFolder . Pour obtenir des exemples qui utilisent des valeurs de l’énumération CommonFolderQuery, consultez les rubriques de ces méthodes.

• CreateFolderQuery(CommonFolderQuery)
• CreateFolderQueryWithOptions. Instanciez les QueryOptions avec le constructeur QueryOptions(CommonFolderQuery).
• CreateItemQueryWithOptions. Instanciez les QueryOptions avec le constructeur QueryOptions(CommonFolderQuery).
• GetFoldersAsync(CommonFolderQuery)
• GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Ces méthodes utilisent la valeur de l’énumération CommonFolderQuery pour initialiser les options DateStackOption, FolderDepth, IndexerOption et SortOrder de la requête.

Appelez la méthode StorageFolder.IsCommonFolderQuerySupported pour déterminer si la valeur CommonFolderQuery que vous souhaitez utiliser est disponible pour le dossier actif.

Conseil

Lorsqu’une requête regroupe des fichiers dans des dossiers virtuels en fonction d’une propriété qui peut avoir plusieurs valeurs (par exemple, System.Author), un fichier particulier peut apparaître dans plusieurs dossiers virtuels, car chaque dossier représente l’une des valeurs multiples.

Les fichiers qui n’ont pas de valeur pour la propriété que la requête utilise pour regrouper des fichiers sont généralement exclus des résultats de la requête.

Voir aussi

• QueryOptions(CommonFolderQuery)
• StorageFolder
• Exemple d’énumération de dossiers (Windows 10)