FileOpenPickerActivatedEventArgs Class

Reference

Definition

Namespace:: Windows.ApplicationModel.Activation

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

JavaScript This type appears as WebUIFileOpenPickerActivatedEventArgs.

public ref class FileOpenPickerActivatedEventArgs sealed : IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

public ref class FileOpenPickerActivatedEventArgs sealed : IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class FileOpenPickerActivatedEventArgs final : IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class FileOpenPickerActivatedEventArgs final : IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class FileOpenPickerActivatedEventArgs : IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class FileOpenPickerActivatedEventArgs : IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

Public NotInheritable Class FileOpenPickerActivatedEventArgs
Implements IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

Public NotInheritable Class FileOpenPickerActivatedEventArgs
Implements IActivatedEventArgsWithUser, IFileOpenPickerActivatedEventArgs, IFileOpenPickerActivatedEventArgs2

Inheritance: Object Platform::Object IInspectable FileOpenPickerActivatedEventArgs

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IActivatedEventArgs IFileOpenPickerActivatedEventArgs IFileOpenPickerActivatedEventArgs2 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 contracts sample demonstrates how to respond to a FileOpenPicker activation point.

// File open picker activated event handler
protected override void OnFileOpenPickerActivated(FileOpenPickerActivatedEventArgs args)
{
    var FileOpenPickerPage = new SDKTemplate.FileOpenPickerPage();
    FileOpenPickerPage.Activate(args);
}

// Overloaded method to respond to fileOpenPicker events
public void Activate(FileOpenPickerActivatedEventArgs args)
{
    // Perform tasks to prepare your app to display its file picker page

    // Get file picker UI
    fileOpenPickerUI = args.FileOpenPickerUI;

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

For C#, args for an OnFileOpenPickerActivated override references a FileOpenPickerActivatedEventArgs object. The OnFileOpenPickerActivated override is in the App.xaml.cs file and the Activate method is in the FileOpenPickerPage.xaml.cs file of the File picker contracts sample.

Remarks

Learn how to provide files for the user to pick from your app in Quickstart: Providing file services through and in the Windows.Storage.Pickers.Provider namespace reference.

A FileOpenPickerActivatedEventArgs object is passed to the app's activated event handler when the user wants to pick files or folders that are provided by the app. This type of activation is indicated by the ActivationKind.FileOpenPicker value that is returned by the Kind property.

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

UWP app 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 OnFileOpenPickerActivated is up to your app code.

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

Version history

Windows version	SDK version	Value added
1607	14393	User

Properties

CallerPackageFamilyName	The package family name of the app that launched your app.
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.
Kind	Gets the activation type.
PreviousExecutionState	Gets the execution state of the app before it was activated.
SplashScreen	Gets a SplashScreen 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.

Applies to