WebUIFileSavePickerActivatedEventArgs Class

Definition

Namespace:

Windows.UI.WebUI

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.

C#/C++/VB This type appears as FileSavePickerActivatedEventArgs.

public ref class WebUIFileSavePickerActivatedEventArgs sealed : IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferral

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUIFileSavePickerActivatedEventArgs final : IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferral

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUIFileSavePickerActivatedEventArgs : IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferral

Public NotInheritable Class WebUIFileSavePickerActivatedEventArgs
Implements IActivatedEventArgsDeferral, IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2

Inheritance

Object Platform::Object IInspectable WebUIFileSavePickerActivatedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IActivatedEventArgs IFileSavePickerActivatedEventArgs IFileSavePickerActivatedEventArgs2 IActivatedEventArgsDeferral IActivatedEventArgsWithUser

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

The File picker sample demonstrates how to respond to a fileSavePicker activated event.

// fileSavePicker activated event handler
function activated(eventObject) {
    // Identify whether app is launched for fileSavePicker
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.fileOpenPicker) {
        // Perform tasks to prepare your app to display its file picker page

        // Get file picker UI
        fileOpenPickerUI = eventObject.detail.fileOpenPickerUI;

        eventObject.setPromise(WinJS.UI.processAll().then(function () {
            // Navigate to either the first scenario or to the last running scenario
            // before suspension or termination.
            var url = scenarios[0].url;
            return WinJS.Navigation.navigate(url, fileOpenPickerUI);
        }));
    }
}

// Register the activated event handler
WinJS.Application.addEventListener("activated", activated, false);

For JavaScript, eventObject contains a webUIFileSavePickerActivatedEventArgs object.

Remarks

Learn more about providing your app as a location where the user can save files in the Quickstart: Providing file services through and in the Windows.Storage.Pickers.Provider namespace reference.

This object is accessed when you implement an event handler for the WinJS.Application.Onactivated or the Windows.UI.WebUI.WebUIApplication.activated events when ActivationKind is fileSavePicker.

Note

This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Version history

Windows version	SDK version	Value added
1607	14393	User

Properties

ActivatedOperation	Gets the app activated operation.
CallerPackageFamilyName	Gets the family name of the caller's package.
EnterpriseId	Gets the ID of the enterprise that owns the file.
FileSavePickerUI	Gets 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	Gets the activation type.
PreviousExecutionState	Gets the execution state of the app before it was activated.
SplashScreen	Gets the splash screen object that provides information about the transition from the splash screen to the activated app.
User	Gets the user that the app was activated for.

See also

• Quickstart: Providing file services through
• File picker contracts sample