WebUIFileOpenPickerActivatedEventArgs WebUIFileOpenPickerActivatedEventArgs WebUIFileOpenPickerActivatedEventArgs Class

Definition

Provides information about an activated event that fires when the user tries to pick files or folders that are provided by the app.

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

public sealed class WebUIFileOpenPickerActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2, IActivatedEventArgsDeferralpublic sealed class WebUIFileOpenPickerActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2, IActivatedEventArgsDeferralPublic NotInheritable Class WebUIFileOpenPickerActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2, IActivatedEventArgsDeferral
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Learn how to offer files for the user to pick from your app in 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 fileOpenPicker.

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)

.

Examples

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


// File open picker activated event handler
function activated(eventObject) {
    // Identify whether app is launched for fileOpenPicker
    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 webUIFileOpenPickerActivatedEventArgs object.

Properties

ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

public ActivatedOperation ActivatedOperation { get; }public ActivatedOperation ActivatedOperation { get; }Public ReadOnly Property ActivatedOperation As ActivatedOperation
Value
ActivatedOperation ActivatedOperation ActivatedOperation

The activation operation.

Attributes

CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName

Gets the family name of the caller's package.

public string CallerPackageFamilyName { get; }public string CallerPackageFamilyName { get; }Public ReadOnly Property CallerPackageFamilyName As string
Value
string string string

The family name of the caller's package

Attributes

FileOpenPickerUI FileOpenPickerUI FileOpenPickerUI

Gets the letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

public FileOpenPickerUI FileOpenPickerUI { get; }public FileOpenPickerUI FileOpenPickerUI { get; }Public ReadOnly Property FileOpenPickerUI As FileOpenPickerUI
Value
FileOpenPickerUI FileOpenPickerUI FileOpenPickerUI

The letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

Attributes

Kind Kind Kind

Gets the activation type.

public ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind
Attributes

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
Attributes

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
Value
SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Attributes

Remarks

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

Gets the user that the app was activated for.

public User User { get; }public User User { get; }Public ReadOnly Property User As User
Value
User User User

The user that the app was activated for.

Attributes

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