FileSavePicker FileSavePicker FileSavePicker FileSavePicker Class

Definition

public : sealed class FileSavePicker : IFileSavePicker, IFileSavePicker2, IFileSavePicker3public sealed class FileSavePicker : IFileSavePicker, IFileSavePicker2, IFileSavePicker3Public NotInheritable Class FileSavePicker Implements IFileSavePicker, IFileSavePicker2, IFileSavePicker3// You can use this class in JavaScript.

Attributes

ActivatableAttribute ContractVersionAttribute MuseAttribute

Examples

The File picker sample demonstrates how to check whether the app is snapped, how to set file picker properties, and how to show a file picker so that the user can save a file.

if (rootPage.EnsureUnsnapped())
{
    FileSavePicker savePicker = new FileSavePicker();
    savePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
    // Dropdown of file types the user can save the file as
    savePicker.FileTypeChoices.Add("Plain Text", new List<string>() { ".txt" });
    // Default file name if the user does not type one in or select a file to replace
    savePicker.SuggestedFileName = "New Document";

    StorageFile file = await savePicker.PickSaveFileAsync();
    if (file != null)
    {
        // Prevent updates to the remote version of the file until we finish making changes and call CompleteUpdatesAsync.
        CachedFileManager.DeferUpdates(file);
        // write to file
        await FileIO.WriteTextAsync(file, file.Name);
        // Let Windows know that we're finished changing the file so the other app can update the remote version of the file.
        // Completing updates may require Windows to ask for user input.
        FileUpdateStatus status = await CachedFileManager.CompleteUpdatesAsync(file);
        if (status == FileUpdateStatus.Complete)
        {
            OutputTextBlock.Text = "File " + file.Name + " was saved.";
        }
        else
        {
            OutputTextBlock.Text = "File " + file.Name + " couldn't be saved.";
        }
    }
    else
    {
        OutputTextBlock.Text = "Operation cancelled.";
    }
}

// Verify that we are currently not snapped, or that we can unsnap to open the picker
var currentState = Windows.UI.ViewManagement.ApplicationView.value;
if (currentState === Windows.UI.ViewManagement.ApplicationViewState.snapped &&
    !Windows.UI.ViewManagement.ApplicationView.tryUnsnap()) {
    // Fail silently if we can't unsnap
    return;
}

// Create the picker object and set options
var savePicker = new Windows.Storage.Pickers.FileSavePicker();
savePicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.documentsLibrary;
// Dropdown of file types the user can save the file as
savePicker.fileTypeChoices.insert("Plain Text", [".txt"]);
// Default file name if the user does not type one in or select a file to replace
savePicker.suggestedFileName = "New Document";

savePicker.pickSaveFileAsync().then(function (file) {
    if (file) {
        // Prevent updates to the remote version of the file until we finish making changes and call CompleteUpdatesAsync.
        Windows.Storage.CachedFileManager.deferUpdates(file);
        // write to file
        Windows.Storage.FileIO.writeTextAsync(file, file.name).done(function () {
            // Let Windows know that we're finished changing the file so the other app can update the remote version of the file.
            // Completing updates may require Windows to ask for user input.
            Windows.Storage.CachedFileManager.completeUpdatesAsync(file).done(function (updateStatus) {
                if (updateStatus === Windows.Storage.Provider.FileUpdateStatus.complete) {
                    WinJS.log && WinJS.log("File " + file.name + " was saved.", "sample", "status");
                } else {
                    WinJS.log && WinJS.log("File " + file.name + " couldn't be saved.", "sample", "status");
                }
            });
        });
    } else {
        WinJS.log && WinJS.log("Operation cancelled.", "sample", "status");
    }
});

FileSavePicker^ savePicker = ref new FileSavePicker();
savePicker->SuggestedStartLocation = PickerLocationId::DocumentsLibrary;

auto plainTextExtensions = ref new Platform::Collections::Vector<String^>();
plainTextExtensions->Append(".txt");
savePicker->FileTypeChoices->Insert("Plain Text", plainTextExtensions);
savePicker->SuggestedFileName = "New Document";

create_task(savePicker->PickSaveFileAsync()).then([this](StorageFile^ file)
{
    if (file != nullptr)
    {
        // Prevent updates to the remote version of the file until we finish making changes and call CompleteUpdatesAsync.
        CachedFileManager::DeferUpdates(file);
        // write to file
        create_task(FileIO::WriteTextAsync(file, file->Name)).then([this, file]()
        {
            // Let Windows know that we're finished changing the file so the other app can update the remote version of the file.
            // Completing updates may require Windows to ask for user input.
            create_task(CachedFileManager::CompleteUpdatesAsync(file)).then([this, file](FileUpdateStatus status)
            {
                if (status == FileUpdateStatus::Complete)
                {
                    OutputTextBlock->Text = "File " + file->Name + " was saved.";
                }
                else
                {
                    OutputTextBlock->Text = "File " + file->Name + " couldn't be saved.";
                }
            });
        });
    }
    else
    {
        OutputTextBlock->Text = "Operation cancelled.";
    }
});

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;
}

Remarks

To learn how to save files through the file picker, see How to save files through file pickers.

To get started accessing files and folders file picker, see Files, folders, and libraries .

public : FileSavePicker()public FileSavePicker()Public Sub New()// You can use this method in JavaScript.

public : PlatForm::String CommitButtonText { get; set; }public string CommitButtonText { get; set; }Public ReadWrite Property CommitButtonText As string// You can use this property in JavaScript.

public : ValueSet ContinuationData { get; }public ValueSet ContinuationData { get; }Public ReadOnly Property ContinuationData As ValueSet// You can use this property in JavaScript.

public : PlatForm::String DefaultFileExtension { get; set; }public string DefaultFileExtension { get; set; }Public ReadWrite Property DefaultFileExtension As string// You can use this property in JavaScript.

public : PlatForm::String EnterpriseId { get; set; }public string EnterpriseId { get; set; }Public ReadWrite Property EnterpriseId As string// You can use this property in JavaScript.

public : IMap<string, IVector<string>> FileTypeChoices { get; }public IDictionary<string, IList<string>> FileTypeChoices { get; }Public ReadOnly Property FileTypeChoices As IDictionary<string, IList<string>>// You can use this property in JavaScript.

FileSavePicker savePicker = new FileSavePicker();
savePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
// Dropdown of file types the user can save the file as
savePicker.FileTypeChoices.Add("Plain Text", new List<string>() { ".txt" });
// Default file name if the user does not type one in or select a file to replace
savePicker.SuggestedFileName = "New Document";

// Create the picker object and set options
var savePicker = new Windows.Storage.Pickers.FileSavePicker();
savePicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.documentsLibrary;
// Dropdown of file types the user can save the file as
savePicker.fileTypeChoices.insert("Plain Text", [".txt"]);
// Default file name if the user does not type one in or select a file to replace
savePicker.suggestedFileName = "New Document";

public : PlatForm::String SettingsIdentifier { get; set; }public string SettingsIdentifier { get; set; }Public ReadWrite Property SettingsIdentifier As string// You can use this property in JavaScript.

public : PlatForm::String SuggestedFileName { get; set; }public string SuggestedFileName { get; set; }Public ReadWrite Property SuggestedFileName As string// You can use this property in JavaScript.

public : StorageFile SuggestedSaveFile { get; set; }public StorageFile SuggestedSaveFile { get; set; }Public ReadWrite Property SuggestedSaveFile As StorageFile// You can use this property in JavaScript.

public : PickerLocationId SuggestedStartLocation { get; set; }public PickerLocationId SuggestedStartLocation { get; set; }Public ReadWrite Property SuggestedStartLocation As PickerLocationId// You can use this property in JavaScript.

public : void PickSaveFileAndContinue()public void PickSaveFileAndContinue()Public Function PickSaveFileAndContinue() As void// You can use this method in JavaScript.

public : IAsyncOperation<StorageFile> PickSaveFileAsync()public IAsyncOperation<StorageFile> PickSaveFileAsync()Public Function PickSaveFileAsync() As IAsyncOperation( Of StorageFile )// You can use this method in JavaScript.

See Also

• File picker sample (Windows 10)
• Files, folders, and libraries
• How to save files with a file picker