WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs WebUIFileActivatedEventArgs Class

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

Syntax

Declaration

public sealed class WebUIFileActivatedEventArgspublic sealed class WebUIFileActivatedEventArgsPublic NotInheritable Class WebUIFileActivatedEventArgs

Remarks

This object is accessed when you implement an event handler for the WinJS.Application.Onactivated or the 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)

.

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
   }
}

Properties summary

Gets the app activation operation.

Gets the identifier for the currently shown app view.

Gets the files for which the app was activated.

Gets the activation type.

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

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

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

Gets the user that the app was activated for.

Gets the action associated with the activated file.

Properties

  • ActivatedOperation
    ActivatedOperation
    ActivatedOperation
    ActivatedOperation

    Gets the app activation operation.

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

    Property Value

  • CurrentlyShownApplicationViewId
    CurrentlyShownApplicationViewId
    CurrentlyShownApplicationViewId
    CurrentlyShownApplicationViewId

    Gets the identifier for the currently shown app view.

    public int CurrentlyShownApplicationViewId { get; }public int CurrentlyShownApplicationViewId { get; }Public ReadOnly Property CurrentlyShownApplicationViewId As int

    Property Value

    • int
      int
      int
      int

      The identifier for the currently shown app view.

  • Files
    Files
    Files
    Files

    Gets the files for which the app was activated.

    public IVectorView<IStorageItem> Files { get; }public IVectorView<IStorageItem> Files { get; }Public ReadOnly Property Files As IVectorView<IStorageItem>

    Property Value

    • The StorageFile objects representing the files being passed to the app.

  • Kind
    Kind
    Kind
    Kind

    Gets the activation type.

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

    Property Value

  • NeighboringFilesQuery
    NeighboringFilesQuery
    NeighboringFilesQuery
    NeighboringFilesQuery

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

    public StorageFileQueryResult NeighboringFilesQuery { get; }public StorageFileQueryResult NeighboringFilesQuery { get; }Public ReadOnly Property NeighboringFilesQuery As StorageFileQueryResult

    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 ApplicationExecutionState

    Property Value

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

    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 User

    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.

  • Verb
    Verb
    Verb
    Verb

    Gets the action associated with the activated file.

    public string Verb { get; }public string Verb { get; }Public ReadOnly Property Verb As string

    Property Value

    • string
      string
      string
      string

      The action.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

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

Details

Assembly

Windows.UI.WebUI.dll