Skip to main content
Version: 11.0.x

StorageProvider

The StorageProvider is central to file and folder management. It provides methods for file and folder selection, checking platform capabilities, and interacting with stored bookmarks.

The StorageProvider can be access through an instance of TopLevel or Window, for more details on accessing TopLevel please visit TopLevel page:

var storage = window.StorageProvider;

Properties​

CanOpen​

Indicates whether it's possible to open a open file picker on the current platform.

bool CanOpen { get; }

CanSave​

Indicates whether it's possible to open a save file picker on the current platform.

bool CanSave { get; }

CanPickFolder​

Indicates whether it's possible to open a folder picker on the current platform.

bool CanPickFolder { get; }

Methods​

OpenFilePickerAsync​

Opens a file picker dialog.

Task<IReadOnlyList<IStorageFile>> OpenFilePickerAsync(FilePickerOpenOptions options);

The method returns an array of selected IStorageFile instances or an empty collection if the user cancels the dialog.

SaveFilePickerAsync​

Opens a save file picker dialog.

Task<IStorageFile?> SaveFilePickerAsync(FilePickerSaveOptions options);

The method returns a saved IStorageFile instance or null if the user cancels the dialog.

OpenFolderPickerAsync​

Opens a folder picker dialog.

Task<IReadOnlyList<IStorageFolder>> OpenFolderPickerAsync(FolderPickerOpenOptions options);

The method returns an array of selected IStorageFolder instances or an empty collection if the user cancels the dialog.

OpenFileBookmarkAsync​

Opens a IStorageBookmarkFile from the bookmark ID.

Task<IStorageBookmarkFile?> OpenFileBookmarkAsync(string bookmark);

The method returns a bookmarked file or null if the operating system denied the request.

OpenFolderBookmarkAsync​

Opens a IStorageBookmarkFolder from the bookmark ID.

Task<IStorageBookmarkFolder?> OpenFolderBookmarkAsync(string bookmark);

The method returns a bookmarked folder or null if the operating system denied the request.

TryGetFileFromPathAsync​

Attempts to read a file from the file system by its path.

Task<IStorageFile?> TryGetFileFromPathAsync(Uri filePath);

The method returns a file or null if it doesn't exist. The filePath parameter is expected to be an absolute path with a "file" scheme, but can be a URI with a "content" scheme on Android.

TryGetFolderFromPathAsync​

Attempts to read a folder from the file system by its path.

Task<IStorageFolder?> TryGetFolderFromPathAsync(Uri folderPath);

The method returns a folder or null if it doesn't exist. The folderPath parameter is expected to be an absolute path with a "file" scheme, but can be a URI with a "content" scheme on Android.

TryGetWellKnownFolderAsync​

Attempts to read a folder from the file system by its well-known folder identifier.

Task<IStorageFolder?> TryGetWellKnownFolderAsync(WellKnownFolder wellKnownFolder);

The method returns a folder or null if it doesn't exist.

Extension methods​

TryGetFileFromPathAsync​

Attempts to read a file from the file system by its path.

Task<IStorageFile?> TryGetFileFromPathAsync(this IStorageProvider provider, string filePath);

The method returns a file or null if it doesn't exist. This method accepts local file path string as a parameter without any scheme. Only supported on the OS, with physical file paths, primarily only desktop.

TryGetFolderFromPathAsync​

Attempts to read a folder from the file system by its path.

Task<IStorageFolder?> TryGetFolderFromPathAsync(this IStorageProvider provider, string folderPath);

The method returns a folder or null if it doesn't exist. This method accepts local folder path string as a parameter without any scheme. Only supported on the OS, with physical file paths, primarily only desktop.

Platform compatibility:​

FeatureManagedWindowsmacOSLinuxBrowserAndroidiOS
OpenFileBookmarkAsync✔*✔*✔*✔*✔✔✔
OpenFolderBookmarkAsync✔*✔*✔*✔*✔✔✔
OpenFilePickerAsync✔**✔✔✔✔✔✔
SaveFilePickerAsync✔**✔✔✔✔✔***✖
OpenFolderPickerAsync✔**✔✔✔✔✔***✔
TryGetFileFromPathAsync✔✔✔✔✖✖✖
TryGetFolderFromPathAsync✔✔✔✔✖✖✖
TryGetWellKnownFolderAsync✔✔✔✔✔✔✔

* Bookmarks are not properly supported on desktop platforms and instead return file path instead. macOS support is planned in order to get it work with Sandboxed Apple Store apps.

** Managed file picker works only on desktop platforms where it's possible to open a custom window.

*** Only Chromium based browsers have a proper support for file pickers.