FileOpenPickerActivatedEventArgs FileOpenPickerActivatedEventArgs FileOpenPickerActivatedEventArgs FileOpenPickerActivatedEventArgs Class

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.

Syntax

Declaration

public sealed class FileOpenPickerActivatedEventArgspublic sealed class FileOpenPickerActivatedEventArgsPublic NotInheritable Class FileOpenPickerActivatedEventArgspublic sealed class FileOpenPickerActivatedEventArgs

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 value that is returned by the Kind property.

Apps written in JavaScript must listen for and handle Activated events.

Windows Store 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(LaunchActivatedEventArgs), but defining overrides for other activation points such as OnFileOpenPickerActivated(FileOpenPickerActivatedEventArgs) is up to your app code.

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

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(FileOpenPickerActivatedEventArgs) override references a FileOpenPickerActivatedEventArgs object. The OnFileOpenPickerActivated(FileOpenPickerActivatedEventArgs) 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.

Properties summary

The package family name of the app that launched your app.

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.

Gets the activation type.

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

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

Gets the user that the app was activated for.

Properties

  • CallerPackageFamilyName
    CallerPackageFamilyName
    CallerPackageFamilyName
    CallerPackageFamilyName

    The package family name of the app that launched your app.

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

    Property Value

    • string
      string
      string
      string

      The caller's package family name.

    Remarks

    If the caller is a non-packaged app (such as a Win32 app), CallerPackageFamilyName will be empty, that is "".

  • FileOpenPickerUI
    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 FileOpenPickerUIpublic FileOpenPickerUI FileOpenPickerUI { get; }

    Property Value

  • Kind
    Kind
    Kind
    Kind

    Gets the activation type.

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

    Property Value

  • 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 ApplicationExecutionStatepublic ApplicationExecutionState PreviousExecutionState { get; }

    Property Value

  • SplashScreen
    SplashScreen
    SplashScreen
    SplashScreen

    Gets a SplashScreen 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 SplashScreenpublic SplashScreen SplashScreen { get; }

    Property Value

  • 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 Userpublic User User { get; }

    Property Value

    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.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.ApplicationModel.Activation.dll