WebUILaunchActivatedEventArgs
WebUILaunchActivatedEventArgs
WebUILaunchActivatedEventArgs
WebUILaunchActivatedEventArgs
Class
Definition
Provides event information when an app is launched.
public : sealed class WebUILaunchActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ILaunchActivatedEventArgs, IPrelaunchActivatedEventArgs, IActivatedEventArgsDeferralpublic sealed class WebUILaunchActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ILaunchActivatedEventArgs, IPrelaunchActivatedEventArgs, IActivatedEventArgsDeferralPublic NotInheritable Class WebUILaunchActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ILaunchActivatedEventArgs, IPrelaunchActivatedEventArgs, IActivatedEventArgsDeferral// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
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 launch.
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
Gets the app activated operation.
public : ActivatedOperation ActivatedOperation { get; }public ActivatedOperation ActivatedOperation { get; }Public ReadOnly Property ActivatedOperation As ActivatedOperation// You can use this property in JavaScript.
The activation operation.
Arguments Arguments Arguments Arguments
Gets the arguments that are passed to the app during its launch activation.
public : PlatForm::String Arguments { get; }public string Arguments { get; }Public ReadOnly Property Arguments As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The list of arguments.
Remarks
These arguments provide additional context for this activation. Similar to command-line arguments, this string can be parsed by an app to determine what action it should take in response to this activation.
Note
An app should always regard the arguments string as untrusted data and must parse and validate the string carefully before taking action based on its contents. Blindly using the arguments string without examining it first can present a security risk.
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// You can use this property in JavaScript.
- Value
- int int int int
The identifier for the currently shown app view.
Remarks
When an app calls CurrentlyShownApplicationViewId in the activated event handler of a secondary window (for example, eventArgs.get_CurrentlyShownApplicationViewId), it gets the view identifier of the child window.
Kind Kind Kind Kind
Gets the activation type.
public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind// You can use this property in JavaScript.
One of the enumeration values.
PrelaunchActivated PrelaunchActivated PrelaunchActivated PrelaunchActivated
Gets an indication about whether a pre-launch has been activated.
public : PlatForm::Boolean PrelaunchActivated { get; }public bool PrelaunchActivated { get; }Public ReadOnly Property PrelaunchActivated As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Indicates whether a pre-launch has been activated. TRUE indicates activated; otherwise, FALSE.
PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState
Gets the execution state of the app before this activation.
public : ApplicationExecutionState PreviousExecutionState { get; }public ApplicationExecutionState PreviousExecutionState { get; }Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState// You can use this property in JavaScript.
- Value
- ApplicationExecutionState ApplicationExecutionState ApplicationExecutionState ApplicationExecutionState
One of the enumeration values.
Remarks
The app uses this information to determine whether it should restore saved state.
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// You can use this property in JavaScript.
The object that provides splash screen information.
Remarks
This property is only meaningful when the app is activated under a contract that expects a window to be presented. If the contract doesn't require a window or if the app is being activated for a background task, this call will fail.
You can listen for the SplashScreen.Dismissed event to trigger additional loading tasks.
TileId TileId TileId TileId
Gets the ID of the source that was invoked to launch the application.
public : PlatForm::String TileId { get; }public string TileId { get; }Public ReadOnly Property TileId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The ID of the tile.
Remarks
As an example, if the user touches a tile to launch the app, then the source ID retrieved through this property is the tile's ID. The ID of an app's primary tile is the same as its AppUserModelId. Secondary tiles have an ID that is specified when they are created. Most other UI elements will set the source ID as the AppuserModelId of the app.
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// You can use this property in JavaScript.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
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.