SearchActivatedEventArgs SearchActivatedEventArgs SearchActivatedEventArgs SearchActivatedEventArgs Class

Definition

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.

public sealed class SearchActivatedEventArgspublic sealed class SearchActivatedEventArgsPublic NotInheritable Class SearchActivatedEventArgspublic sealed class SearchActivatedEventArgs
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

If your app integrates with the Search contract, a SearchActivatedEventArgs object is passed to your app's OnSearchActivated(SearchActivatedEventArgs) 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

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 intpublic int CurrentlyShownApplicationViewId { get; }
Value
int int int int

The identifier for the currently shown app view.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Kind Kind Kind Kind

Gets the activation type.

public ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKindpublic ActivationKind Kind { get; }
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 stringpublic string Language { get; }
Value
string string string string

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

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 SearchPaneQueryLinguisticDetailspublic SearchPaneQueryLinguisticDetails LinguisticDetails { get; }
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 ApplicationExecutionStatepublic ApplicationExecutionState PreviousExecutionState { get; }
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 stringpublic string QueryText { get; }
Value
string string string string

The text to search for.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 SplashScreenpublic SplashScreen SplashScreen { get; }
Value
SplashScreen SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 Userpublic User User { get; }
Value
User User User User

The user that the app was activated for.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 ActivationViewSwitcherpublic ActivationViewSwitcher ViewSwitcher { get; }
Value
ActivationViewSwitcher ActivationViewSwitcher ActivationViewSwitcher ActivationViewSwitcher

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be null in hosted scenarios such as Share and File Picker activations.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)