SearchActivatedEventArgs class (Windows)

This topic has not yet been rated - Rate this topic

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

C++


public sealed class SearchActivatedEventArgs : Object,
    ISearchActivatedEventArgs,
    IActivatedEventArgs

Attributes

MarshalingBehaviorAttribute(Agile)
VersionAttribute(NTDDI_WIN8)

Members

The SearchActivatedEventArgs class has these types of members:

Methods
Properties

Methods

The SearchActivatedEventArgs class inherits methods from the Object class.

Properties

The SearchActivatedEventArgs class has these properties.

Property	Access type	Description
Kind	Read-only	Gets the activation type.
Language	Read-only	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.
PreviousExecutionState	Read-only	Gets the execution state of the app before it was activated.
QueryText	Read-only	Gets the text that the user wants the app to search for.
SplashScreen	Read-only	Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

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.

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

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Minimum supported phone	Windows Phone 8
Namespace	Windows.ApplicationModel.Activation Windows::ApplicationModel::Activation [C++]
Metadata	Windows.winmd

SearchActivatedEventArgs class