WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs Class

Definition

Provides data when an app is activated because it is the app associated with a file.

public : sealed class WebUIFileActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgs, IFileActivatedEventArgsWithNeighboringFiles, IActivatedEventArgsDeferral
struct winrt::Windows::UI::WebUI::WebUIFileActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgs, IFileActivatedEventArgsWithNeighboringFiles, IActivatedEventArgsDeferral
public sealed class WebUIFileActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgs, IFileActivatedEventArgsWithNeighboringFiles, IActivatedEventArgsDeferral
Public NotInheritable Class WebUIFileActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgs, IFileActivatedEventArgsWithNeighboringFiles, IActivatedEventArgsDeferral
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The activated event handler receives all activation events. The property indicates the type of activation event. This example is set up to handle file activation events.

function onActivatedHandler(eventArgs) {
   if (eventArgs.detail.kind == Windows.ApplicationModel.Activation.ActivationKind.file) 
   {
       // TODO: Handle file activation.

       // The number of files received is eventArgs.detail.files.size
       // The first file is eventArgs.detail.files[0].name
   }
}

Remarks

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 file. Note that when your app is activated for the file contract you must access the data using the StorageFile objects passed to your app through the Files property. You should not attempt to access the path of the file since your app may not have permission to the file’s location.

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 ActivatedOperation

Gets the app activation operation.

CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId

Gets the identifier for the currently shown app view.

Files Files Files Files Files

Gets the files for which the app was activated.

Kind Kind Kind Kind Kind

Gets the activation type.

NeighboringFilesQuery NeighboringFilesQuery NeighboringFilesQuery NeighboringFilesQuery NeighboringFilesQuery

Gets the neighboring files of the files for which the app was activated.

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

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

SplashScreen SplashScreen SplashScreen SplashScreen SplashScreen

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

User User User User User

Gets the user that the app was activated for.

Verb Verb Verb Verb Verb

Gets the action associated with the activated file.

See Also