SearchActivatedEventArgs SearchActivatedEventArgs SearchActivatedEventArgs SearchActivatedEventArgs Class

Provides information about the activated event that fires when the user searches the app from the Search charm and the app isn't the main app on screen.

JavaScript This type appears as WebUISearchActivatedEventArgs.

Syntax

Declaration

public sealed class SearchActivatedEventArgspublic sealed class SearchActivatedEventArgsPublic NotInheritable Class SearchActivatedEventArgs

Remarks

If your app integrates with the Search contract, a SearchActivatedEventArgs object is passed to your app's OnSearchActivated activation point handler when the user searches the app from the Search charm and your app is not the main app on screen. This type of activation is indicated by the ActivationKind value returned by the Kind property.

Learn how to let users search with your app in Quickstart: Adding search. Learn about responding to other search-related events and customizing the search box and suggestions using the SearchPane class in the Windows.ApplicationModel.Search namespace reference.

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

Examples

The Search contract sample demonstrates how to respond to a Search activated event.

Note

Activate() is called in the EnsureMainPageActivatedAsync private method, not shown.

()

async protected override void OnSearchActivated(SearchActivatedEventArgs args)
{
    await EnsureMainPageActivatedAsync(args);
    if (args.QueryText == "")
    {
        // Navigate to landing page.
    }
    else
    {
        // Display search results.
        MainPage.Current.ProcessQueryText(args.QueryText);
    }
}

Properties summary

Gets the identifier for the currently shown app view.

Gets the activation type.

Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

Gets a SearchPaneQueryLinguisticDetails object that provides info about query text that the user enters through an Input Method Editor (IME).

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

Gets the text that the user wants the app to search for. The user entered this text into the search box of the search pane.

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.

Gets the view switcher object that allows you to set the view for the application.

Properties

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

  • Kind
    Kind
    Kind
    Kind

    Gets the activation type.

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

    Property Value

  • Language
    Language
    Language
    Language

    Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

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

    Property Value

    • string
      string
      string
      string

      The Internet Engineering Task Force (IETF) BCP 47 standard language tag.

  • LinguisticDetails
    LinguisticDetails
    LinguisticDetails
    LinguisticDetails

    Gets a SearchPaneQueryLinguisticDetails object that provides info about query text that the user enters through an Input Method Editor (IME).

    public SearchPaneQueryLinguisticDetails LinguisticDetails { get; }public SearchPaneQueryLinguisticDetails LinguisticDetails { get; }Public ReadOnly Property LinguisticDetails As SearchPaneQueryLinguisticDetails

    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

  • QueryText
    QueryText
    QueryText
    QueryText

    Gets the text that the user wants the app to search for. The user entered this text into the search box of the search pane.

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

    Property Value

    • string
      string
      string
      string

      The text to search for.

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

  • ViewSwitcher
    ViewSwitcher
    ViewSwitcher
    ViewSwitcher

    Gets the view switcher object that allows you to set the view for the application.

    public ActivationViewSwitcher ViewSwitcher { get; }public ActivationViewSwitcher ViewSwitcher { get; }Public ReadOnly Property ViewSwitcher As ActivationViewSwitcher

    Property Value

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.ApplicationModel.Activation.dll