SearchActivatedEventArgs Class

Definition

Namespace:

Windows.ApplicationModel.Activation

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 : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SearchActivatedEventArgs final : 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 : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider

Public NotInheritable Class SearchActivatedEventArgs
Implements IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IViewSwitcherProvider

Inheritance

Object Platform::Object IInspectable SearchActivatedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IActivatedEventArgs IApplicationViewActivatedEventArgs ISearchActivatedEventArgs ISearchActivatedEventArgsWithLinguisticDetails IViewSwitcherProvider IActivatedEventArgsWithUser

Windows requirements

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

Remarks

Important

To implement search in an app for Windows 10 or later, use AutoSuggestBox. See Auto-suggest box for more info.

You should not use Windows.ApplicationModel.Search APIs (SearchPane, SearchContract) or SearchBox APIs in apps for Windows 10 or later.

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.

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.

See also

• Application
• ActivationKind
• Windows.ApplicationModel.Search
• SearchPane
• Activated
• OnSearchActivated(SearchActivatedEventArgs)
• Activated
• Call asynchronous APIs in C# or Visual Basic
• Search contract sample (Windows 8)