FileOpenPicker Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt ein UI-Element dar, mit dem der Benutzer Dateien auswählen und öffnen kann.
Bevor Sie in einer Desktop-App eine Instanz dieser Klasse so verwenden, dass die Benutzeroberfläche angezeigt wird, müssen Sie das Objekt dem Fensterhandle des Besitzers zuordnen. Weitere Informationen und Codebeispiele finden Sie unter Anzeigen von WinRT-UI-Objekten, die von CoreWindow abhängen.
public ref class FileOpenPicker sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class FileOpenPicker final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class FileOpenPicker final
/// [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.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class FileOpenPicker
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class FileOpenPicker
[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
- Vererbung
- Attribute
Windows-Anforderungen
Gerätefamilie |
Windows 10 (eingeführt in 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (eingeführt in v1.0)
|
Beispiele
Das Beispiel für die Dateiauswahl zeigt, wie Sie überprüfen, ob die App angeknipst ist, wie Sie Dateiauswahleigenschaften festlegen und eine Dateiauswahl anzeigen, damit der Benutzer eine Datei auswählen kann.
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;
}
Hinweis
Sie sollten immer sicherstellen, dass Ihre App nicht angedockt ist (oder dass sie nicht verwendet werden kann) und Dateiauswahleigenschaften festlegen, unabhängig davon, ob der Benutzer eine einzelne Datei oder mehrere Dateien auswählt.
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");
}
});
Hinweise
Informationen zum Zugreifen auf Dateien und Ordner finden Sie unter Schnellstart: Zugreifen auf Dateien mit Dateiauswahl.
Informationen zur Verwendung dieser API außerhalb von UWP-Apps finden Sie unter Aufrufen von Interop-APIs aus einer .NET-App.
Versionsverlauf
Windows-Version | SDK-Version | Wertschöpfung |
---|---|---|
1903 | 18362 | CreateForUser |
1903 | 18362 | Benutzer |
Konstruktoren
FileOpenPicker() |
Erstellt eine neue Instanz eines FileOpenPicker. Bevor Sie in einer Desktop-App eine Instanz dieser Klasse so verwenden, dass die Benutzeroberfläche angezeigt wird, müssen Sie das Objekt dem Fensterhandle des Besitzers zuordnen. Weitere Informationen und Codebeispiele finden Sie unter Anzeigen von WinRT-UI-Objekten, die von CoreWindow abhängen. |
Eigenschaften
CommitButtonText |
Ruft den Beschriftungstext der Commitschaltfläche der Dateiöffnungsauswahl ab oder legt diesen fest. |
ContinuationData |
Ruft einen Satz von Werten ab, die von der App vor dem PickSingleFileAndContinue - oder PickMultipleFilesAndContinue-Vorgang aufgefüllt werden sollen, der die App deaktiviert, um Kontext bereitzustellen, wenn die App aktiviert wird. (Windows Phone 8.x-App) |
FileTypeFilter |
Ruft die Auflistung von Dateitypen ab, die von der Dateiöffnungsauswahl angezeigt wird. |
SettingsIdentifier |
Ruft den Einstellungsbezeichner ab, der dem Zustand der Dateiöffnungsauswahl zugeordnet ist, oder legt diesen fest. |
SuggestedStartLocation |
Ruft den ursprünglichen Speicherort ab, an dem die Dateiöffnungsauswahl nach Dateien sucht, die dem Benutzer präsentiert werden sollen, oder legt diesen fest. |
User |
Ruft Informationen zu dem Benutzer ab, für den fileOpenPicker erstellt wurde. Verwenden Sie diese Eigenschaft für Anwendungen mit mehreren Benutzern. |
ViewMode |
Ruft den Ansichtsmodus ab, den die Dateiöffnungsauswahl zum Anzeigen von Elementen verwendet, oder legt diesen fest. |
Methoden
CreateForUser(User) |
Erstellt einen FileOpenPicker , der auf das persönliche Verzeichnis des angegebenen Benutzers festgelegt ist. Verwenden Sie diese Methode für Anwendungen mit mehreren Benutzern. |
PickMultipleFilesAndContinue() |
Veraltet ab Windows 10; verwenden Sie stattdessen PickSingleFolderAsync. Zeigt die Dateiauswahl an, sodass der Benutzer mehrere Dateien auswählen kann, die App deaktiviert und nach Abschluss des Vorgangs reaktiviert werden kann. (Windows Phone 8.x-App) |
PickMultipleFilesAsync() |
Zeigt die Dateiauswahl an, damit der Benutzer mehrere Dateien auswählen kann. (UWP-App) |
PickSingleFileAndContinue() |
Zeigt die Dateiauswahl an, damit der Benutzer eine Datei auswählen kann, wobei die App möglicherweise deaktiviert und nach Abschluss des Vorgangs reaktiviert wird. (Windows Phone 8.x-App) |
PickSingleFileAsync() |
Zeigt die Dateiauswahl an, damit der Benutzer eine Datei auswählen kann. |
PickSingleFileAsync(String) |
Zeigt die Dateiauswahl an, damit der Benutzer eine Datei auswählen kann. |
ResumePickSingleFileAsync() |
Setzt den Auswahlvorgang fort, um die vom Benutzer ausgewählte Datei abzurufen, wenn der Benutzer von der App navigiert, nachdem der Auswahlvorgang abgeschlossen ist und die App angehalten wird. |