WebUISearchActivatedEventArgs Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
C#/C++/VB This type appears as SearchActivatedEventArgs.
public ref class WebUISearchActivatedEventArgs sealed : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IActivatedEventArgsDeferral/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Activation.WebUISearchActivatedEventsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUISearchActivatedEventArgs final : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IActivatedEventArgsDeferral[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Activation.WebUISearchActivatedEventsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUISearchActivatedEventArgs : IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails, IActivatedEventArgsDeferralPublic NotInheritable Class WebUISearchActivatedEventArgs
Implements IActivatedEventArgsDeferral, IApplicationViewActivatedEventArgs, ISearchActivatedEventArgs, ISearchActivatedEventArgsWithLinguisticDetails- Inheritance
- Attributes
- Implements
Windows requirements
| Device family |
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
Windows Mobile Extension SDK (introduced in 10.0.10240.0) |
| API contract |
Windows.ApplicationModel.Activation.WebUISearchActivatedEventsContract (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 webUISearchActivatedEventArgs is passed to your app's onactivated event 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.
Note
This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).
Properties
| ActivatedOperation |
Gets the app activated operation. |
| 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 the splash screen object that provides information about the transition from the splash screen to the activated app. |