ILaunchActivatedEventArgs ILaunchActivatedEventArgs ILaunchActivatedEventArgs ILaunchActivatedEventArgs Interface

Provides event information when an app is launched.

Syntax

Declaration

public interface ILaunchActivatedEventArgspublic interface ILaunchActivatedEventArgsPublic Interface ILaunchActivatedEventArgspublic interface ILaunchActivatedEventArgs

Inheritance Hierarchy

Remarks

Interface inheritance

ILaunchActivatedEventArgs inherits IActivatedEventArgs. Types that implement ILaunchActivatedEventArgs also implement the interface members of IActivatedEventArgs.

Properties summary

Gets the arguments that are passed to the app during its launch activation.

Gets the ID of the tile that was invoked to launch the app.

Properties

  • Arguments
    Arguments
    Arguments
    Arguments

    Gets the arguments that are passed to the app during its launch activation.

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

    Property Value

    • string
      string
      string
      string

      The list of arguments.

  • TileId
    TileId
    TileId
    TileId

    Gets the ID of the tile that was invoked to launch the app.

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

    Property Value

    • string
      string
      string
      string

      The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the TileId value, assigned to the secondary tile when it was created, is returned.

    Remarks

    Starting with Windows 10, TileId behavior is different for apps that are launched after having been terminated. Previously, the TileId always returned the ID of the tile that launched the app. The TileId behavior now depends on how the app is reactivated:

    How the app is reactivatedBehavior of TileId
    The user switches to the app by using the task switcher or by using the global back keyReturns the empty string ("").
    The user taps the app tileReturns the tile ID.

    The new behavior makes it possible to differentiate between a switch to the app versus a re-launch of the app. If your app uses tile ID information during activation, handle the TileId=="" case. For example:

    protected override void OnLaunched(LaunchActivatedEventArgs e)
    {
    ...
      if (e.TileId == "")
      {
        // resumed from switch/backstack
      }
      else
      {
        // resumed from tile launch
      }
    ...
    }
    

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.ApplicationModel.Activation.dll