WebUIFileOpenPickerActivatedEventArgs class

Applies to Windows and Windows Phone

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.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Attributes

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

Members

The WebUIFileOpenPickerActivatedEventArgs class has these types of members:

Methods

The WebUIFileOpenPickerActivatedEventArgs class inherits methods from the Object class (C#/VB/C++).

Properties

The WebUIFileOpenPickerActivatedEventArgs class has these properties.

PropertyAccess typeDescription

ActivatedOperation

Read-onlyGets the app activated operation.

FileOpenPickerUI

Read-onlyGets 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.

Kind

Read-onlyGets the activation type.

PreviousExecutionState

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

SplashScreen

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

 

Remarks

Learn how to offer files for the user to pick from your app in Quickstart: Providing file services through file pickers 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.

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 Runtime apps only]

Namespace

Windows.UI.WebUI

Metadata

Windows.winmd

See also

Quickstart: Providing file services through file pickers

 

 

Show:
© 2014 Microsoft. All rights reserved.