FileSavePickerActivatedEventArgs class

Applies to Windows and Windows Phone

Provides information about an activated event that fires when the user saves a file through the file picker and selects the app as the location.

JavaScript:  This type appears as WebUIFileSavePickerActivatedEventArgs.

Syntax


public sealed class FileSavePickerActivatedEventArgs : IFileSavePickerActivatedEventArgs,
    IActivatedEventArgs

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

Members

The FileSavePickerActivatedEventArgs class has these types of members:

Properties

The FileSavePickerActivatedEventArgs class has these properties.

PropertyAccess typeDescription

FileSavePickerUI

Read-onlyGets the letterbox UI of the file picker that is displayed when the user saves a file and selects the app as the save location.

Kind

Read-onlyGets the activation type.

PreviousExecutionState

Read-onlyGets the execution state of the app before it was activated.

SplashScreen

Read-onlyGets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

 

Remarks

Learn more about providing your app as a location where the user can save files in the Windows.Storage.Pickers.Provider namespace reference.

A FileSavePickerActivatedEventArgs object is passed to the app's activation point handler when the user saves a file through the file picker and selects the app as the location. This type of activation is indicated by the ActivationKind.FileSavePicker value returned by the Kind property.

Apps written in JavaScript must listen for and handle Windows.UI.WebUI.webUIApplication.activated events.

Windows Store apps using C++, C#, or Visual Basic typically implement activation points by overriding methods of the Application object. The default template app.xaml code-behind files always include an override for OnLaunched, but defining overrides for other activation points such as OnFileSavePickerActivated is up to your app code.

All Application overrides involved in an activation scenario should call Window.Activate in their implementations.

Examples

The File picker contracts sample demonstrates how to respond to a FileSavePicker activation point.



// fileSavePicker activated event handler
protected override void OnFileSavePickerActivated(FileSavePickerActivatedEventArgs args)
{
    var FileSavePickerPage = new SDKTemplate.FileSavePickerPage();
    FileSavePickerPage.Activate(args);
}

// Overloaded method to respond to fileSavePicker events
internal void Activate(FileSavePickerActivatedEventArgs args)
{
    // Perform tasks to prepare your app to display its file picker page

    // Get file picker UI
    fileSavePickerUI = args.FileSavePickerUI;

    Window.Current.Content = this;
    this.OnNavigatedTo(null);
    Window.Current.Activate();
}

For C#, args for an OnFileSavePickerActivated override on the Application object references a FileSavePickerActivatedEventArgs object. The OnFileSavePickerActivated override is in the App.xaml.cs file and the Activate method is in the FileSavePickerPage.xaml.cs file of the File picker contracts sample.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.ApplicationModel.Activation
Windows::ApplicationModel::Activation [C++]

Metadata

Windows.winmd

See also

General reference
Windows.Storage.Pickers.Provider namespace
JavaScript app reference
Windows.UI.WebUI.WebUIApplication.Activated event
C#/C++/VB app reference
Windows.UI.Core.CoreApplicationView.Activated event
OnFileSavePickerActivated
Application
File picker contracts sample

 

 

Show:
© 2014 Microsoft