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 ref class SearchActivatedEventArgs sealed : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
public ref class SearchActivatedEventArgs sealed : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
class SearchActivatedEventArgs sealed : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
class SearchActivatedEventArgs sealed : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchActivatedEventArgs : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchActivatedEventArgs : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
Public NotInheritable Class SearchActivatedEventArgs
Implements IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
Public NotInheritable Class SearchActivatedEventArgs
Implements IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider
Inheritance
SearchActivatedEventArgs
Attributes
Implements

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

Note

Window.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);
    }
}

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.Search 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 Window.Activate in their implementations.

Version history

Windows version SDK version Value added
1607 14393 User

Properties

CurrentlyShownApplicationViewId

Gets the identifier for the currently shown app view.

Kind

Gets the activation type.

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.

LinguisticDetails

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

PreviousExecutionState

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

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.

SplashScreen

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

User

Gets the user that the app was activated for.

ViewSwitcher

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

Applies to

See also