WebUIFileSavePickerActivatedEventArgs WebUIFileSavePickerActivatedEventArgs WebUIFileSavePickerActivatedEventArgs WebUIFileSavePickerActivatedEventArgs Class

Definition

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 : sealed class WebUIFileSavePickerActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferralpublic sealed class WebUIFileSavePickerActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferralPublic NotInheritable Class WebUIFileSavePickerActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IFileSavePickerActivatedEventArgs, IFileSavePickerActivatedEventArgs2, IActivatedEventArgsDeferral// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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)

.

Properties

ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

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

CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName

Gets the family name of the caller's package.

public : PlatForm::String CallerPackageFamilyName { get; }public string CallerPackageFamilyName { get; }Public ReadOnly Property CallerPackageFamilyName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The family name of the caller's package.

EnterpriseId EnterpriseId EnterpriseId EnterpriseId

Gets the ID of the enterprise that owns the file.

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

The ID of the enterprise that owns the file.

FileSavePickerUI FileSavePickerUI FileSavePickerUI 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.

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

The letterbox UI of the file picker that is displayed when the user saves a file and uses the app as the location.

Kind Kind Kind Kind

Gets the activation type.

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

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

Gets the execution state of the app before it was activated.

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

SplashScreen SplashScreen SplashScreen SplashScreen

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

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

The object that provides splash screen information.

Examples

The Splash screen sample demonstrates how to retrieve a splashScreen object in its activated event handler, if the app was launched:


// Identify and respond to all app activated events.
WinJS.Application.onactivated = function (eventObject) {

    // App was launched
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.launch) {
        // Retrieve splash screen object
        splash = eventObject.detail.splashScreen;

        // Add code get image coordinates or listen for the dismissed event

        WinJS.UI.processAll();
    }
    // Add code to respond to other activated event types
};

In the sample, eventObject is an object provides information about the activated event. In the case of a ActivationKind.launch activated event, the eventObject is a WebUILaunchActivatedEventArgs object.

User User User User

Gets the user that the app was activated for.

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

The user that the app was activated for.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for.

This property returns null when a multi-user application is activated with no specific user context.

Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials.

See Also