Windows Dev Center

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


public sealed class SearchActivatedEventArgs : ISearchActivatedEventArgs,
    IActivatedEventArgs,
    IApplicationViewActivatedEventArgs,
    ISearchActivatedEventArgsWithLinguisticDetails

Members

The SearchActivatedEventArgs class has these types of members:

Properties

The SearchActivatedEventArgs class has these properties.

PropertyAccess typeDescription

CurrentlyShownApplicationViewId

Read-onlyGets the identifier for the currently shown app view.

Kind

Read-onlyGets the activation type.

Language

Read-onlyGets 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

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

PreviousExecutionState

Read-onlyGets the execution state of the app before it was activated.

QueryText

Read-onlyGets the text that the user wants the app to search for.

SplashScreen

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

ViewSwitcher

Read-onlyGets the view switcher object that allows you to set the view for the application.

 

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 (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.ApplicationModel.Activation
Windows::ApplicationModel::Activation [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

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

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

See also

Object
ISearchActivatedEventArgs
IActivatedEventArgs
IApplicationViewActivatedEventArgs
ISearchActivatedEventArgsWithLinguisticDetails
Quickstart: Adding search
Call asynchronous APIs in C# or Visual Basic
Application
OnSearchActivated
Search contract sample
General reference
ActivationKind enumeration
Windows.ApplicationModel.Search namespace
Windows.ApplicationModel.Search.SearchPane class
JavaScript app reference
Windows.UI.WebUI.WebUIApplication.Activated event
C#/C++/VB app reference
OnSearchActivated
Windows.UI.Core.CoreApplicationView.Activated event

 

 

Show:
© 2015 Microsoft