FileOpenPicker Classe

Définition

Espace de noms:

Windows.Storage.Pickers

Représente un élément d’interface utilisateur qui permet à l’utilisateur de choisir et d’ouvrir des fichiers.

Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.

public ref class FileOpenPicker sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class FileOpenPicker final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class FileOpenPicker

function FileOpenPicker()

Public NotInheritable Class FileOpenPicker

Héritage

Object Platform::Object IInspectable FileOpenPicker

Attributs

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Configuration requise pour Windows

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

Exemples

L’exemple de sélecteur de fichiers montre comment vérifier si l’application est ancrée, comment définir les propriétés du sélecteur de fichiers et comment afficher un sélecteur de fichiers afin que l’utilisateur puisse choisir un fichier.

FileOpenPicker openPicker = new FileOpenPicker();
openPicker.ViewMode = PickerViewMode.Thumbnail;
openPicker.SuggestedStartLocation = PickerLocationId.PicturesLibrary;
openPicker.FileTypeFilter.Add(".jpg");
openPicker.FileTypeFilter.Add(".jpeg");
openPicker.FileTypeFilter.Add(".png");

StorageFile file = await openPicker.PickSingleFileAsync();
if (file != null)
{
    // Application now has read/write access to the picked file
    OutputTextBlock.Text = "Picked photo: " + file.Name;
}
else
{
    OutputTextBlock.Text = "Operation cancelled.";
}

// Create the picker object and set options
var openPicker = new Windows.Storage.Pickers.FileOpenPicker();
openPicker.viewMode = Windows.Storage.Pickers.PickerViewMode.thumbnail;
openPicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.picturesLibrary;
// Users expect to have a filtered view of their folders depending on the scenario.
// For example, when choosing a documents folder, restrict the filetypes to documents for your application.
openPicker.fileTypeFilter.replaceAll([".png", ".jpg", ".jpeg"]);

// Open the picker for the user to pick a file
openPicker.pickSingleFileAsync().then(function (file) {
    if (file) {
        // Application now has read/write access to the picked file
        WinJS.log && WinJS.log("Picked photo: " + file.name, "sample", "status");
    } else {
        // The picker was dismissed with no selected file
        WinJS.log && WinJS.log("Operation cancelled.", "sample", "status");
    }
});

internal bool EnsureUnsnapped()
{
    // FilePicker APIs will not work if the application is in a snapped state.
    // If an app wants to show a FilePicker while snapped, it must attempt to unsnap first
    bool unsnapped = ((ApplicationView.Value != ApplicationViewState.Snapped) || ApplicationView.TryUnsnap());
    if (!unsnapped)
    {
        NotifyUser("Cannot unsnap the sample.", NotifyType.StatusMessage);
    }

    return unsnapped;
}

Notes

Vous devez toujours vous assurer que votre application n’est pas ancrée (ou qu’elle peut être non activée) et définir les propriétés du sélecteur de fichiers, que l’utilisateur sélectionne un seul fichier ou plusieurs fichiers.

IReadOnlyList<StorageFile> files = await openPicker.PickMultipleFilesAsync();
if (files.Count > 0)
{
    StringBuilder output = new StringBuilder("Picked files:\n");
    // Application now has read/write access to the picked file(s)
    foreach (StorageFile file in files)
    {
        output.Append(file.Name + "\n");
    }
    OutputTextBlock.Text = output.ToString();
}
else
{
    OutputTextBlock.Text = "Operation cancelled.";
}

openPicker.pickMultipleFilesAsync().then(function (files) {
    if (files.size > 0) {
        // Application now has read/write access to the picked file(s)
        var outputString = "Picked files:\n";
        for (var i = 0; i < files.size; i++) {
            outputString = outputString + files[i].name + "\n";
        }
        WinJS.log && WinJS.log(outputString, "sample", "status");
    } else {
        // The picker was dismissed with no selected file
        WinJS.log && WinJS.log("Operation cancelled.", "sample", "status");
    }
});

Remarques

Pour commencer à accéder au sélecteur de fichiers et de dossiers, consultez Démarrage rapide : Accès aux fichiers avec les sélecteurs de fichiers.

Pour plus d’informations sur l’utilisation de cette API en dehors des applications UWP, consultez Appeler des API d’interopérabilité à partir d’une application .NET.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1903	18362	CreateForUser
1903	18362	Utilisateur

Constructeurs

FileOpenPicker()

Crée une instance d’un FichierOpenPicker. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.

Propriétés

CommitButtonText	Obtient ou définit le texte d’étiquette du bouton de validation du sélecteur ouvert de fichier.
ContinuationData	Obtient un ensemble de valeurs à remplir par l’application avant l’opération PickSingleFileAndContinue ou PickMultipleFilesAndContinue qui désactive l’application afin de fournir un contexte lorsque l’application est activée. (Windows Phone application 8.x)
FileTypeFilter	Obtient la collection de types de fichiers que le sélecteur ouvert de fichiers affiche.
SettingsIdentifier	Obtient ou définit l’identificateur de paramètres associé à l’état du sélecteur d’ouverture de fichier.
SuggestedStartLocation	Obtient ou définit l’emplacement initial où le sélecteur de fichiers ouverts recherche les fichiers à présenter à l’utilisateur.
User	Obtient des informations sur l’utilisateur pour lequel FileOpenPicker a été créé. Utilisez cette propriété pour les applications multi-utilisateurs.
ViewMode	Obtient ou définit le mode d’affichage utilisé par le sélecteur d’ouverture de fichier pour afficher les éléments.

Méthodes

CreateForUser(User)	Crée un FileOpenPicker qui est limité au répertoire personnel de l’utilisateur spécifié. Utilisez cette méthode pour les applications multi-utilisateurs.
PickMultipleFilesAndContinue()	Obsolète à partir de Windows 10 ; utilisez plutôt PickSingleFolderAsync. Affiche le sélecteur de fichiers afin que l’utilisateur puisse sélectionner plusieurs fichiers, en désactivant et l’application et en la réactivant une fois l’opération terminée. (Windows Phone application 8.x)
PickMultipleFilesAsync()	Affiche le sélecteur de fichiers afin que l’utilisateur puisse choisir plusieurs fichiers. (Application UWP)
PickSingleFileAndContinue()	Affiche le sélecteur de fichiers afin que l’utilisateur puisse choisir un fichier, ce qui peut éventuellement désactiver l’application et la réactiver une fois l’opération terminée. (Windows Phone application 8.x)
PickSingleFileAsync()	Affiche le sélecteur de fichiers afin que l’utilisateur puisse choisir un fichier.
PickSingleFileAsync(String)	Affiche le sélecteur de fichiers afin que l’utilisateur puisse choisir un fichier.
ResumePickSingleFileAsync()	Reprend l’opération de sélection pour récupérer le fichier sélectionné par l’utilisateur si l’utilisateur quitte l’application une fois l’opération de sélecteur terminée et l’application suspendue.

Voir aussi

• Exemple de sélecteur de fichiers
• Démarrage rapide : Accès aux fichiers avec les sélecteurs de fichiers
• Exemple d’objets blob
• Afficher les objets d’interface utilisateur WinRT qui dépendent de CoreWindow