WebUISearchActivatedEventArgs クラス
TOC
目次を折りたたむ
目次を展開する

WebUISearchActivatedEventArgs Class

ユーザーが検索チャームから検索し、アプリが画面上のメイン アプリではない場合に発生するアクティブ化されたイベントに関する情報を提供します。

C#/C++/VB:  この型は SearchActivatedEventArgs として表示されます。

構文


/* このオブジェクトの作成とアクセスについては、「解説」を参照してください。 */

属性

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

メンバー

WebUISearchActivatedEventArgsクラス には次の種類のメンバーがあります。

メソッド

The WebUISearchActivatedEventArgs クラス からメソッドを継承します。Object クラス (C#/VB/C++).

プロパティ

WebUISearchActivatedEventArgsクラス には次のプロパティがあります。

プロパティアクセスの種類説明

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.

SplashScreen

読み取り専用Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

 

解説

アプリケーションが検索コントラクトと統合される場合、ユーザーが検索チャームからアプリケーションを検索し、アプリケーションが画面上の主要なアプリケーションでないときは、webUISearchActivatedEventArgs がアプリケーションの onactivated イベント ハンドラーに渡されます。 このアクティベーションの種類は、kind プロパティによって返される activationKind.search の値によって示されます。

クイック スタート: アプリへの検索の追加」で、アプリケーションで検索する方法について学習します。検索に関連する他のイベントへの応答、Windows.ApplicationModel.Search 名前空間参照の searchPane クラスを使用した検索ボックスおよび候補のカスタマイズについて学習します。

メモ  : このクラスはアジャイルではないため、そのスレッド モデルとマーシャリングの動作を考慮する必要があります。詳細については、「スレッドとマーシャリング (C++/CX)」を参照してください。

Search contract サンプルは、search によってアクティブ化したイベントに応答する方法を示します。


function activated(eventObject) {
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.launch) {
        // Use setPromise to indicate to the system that the splash screen must not be torn down
        // until after processAll and navigate complete asynchronously.
        eventObject.setPromise(WinJS.UI.processAll().then(function () {
            // Navigate to either the first scenario or to the last running scenario
            // before suspension or termination.
            var url = WinJS.Application.sessionState.lastUrl || scenarios[0].url;
            return WinJS.Navigation.navigate(url);
        }));
    } else if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.search) {
        // Use setPromise to indicate to the system that the splash screen must not be torn down
        // until after processAll and navigate complete asynchronously.
        eventObject.setPromise(WinJS.UI.processAll().then(function () {
            if (eventObject.detail.queryText === "") {
                // Navigate to your landing page since the user is pre-scoping to your app.
            } else {
                // Display results in UI for eventObject.detail.queryText and eventObject.detail.language.
                // eventObject.detail.language represents user's locale.
            }
            // Navigate to the first scenario since it handles search activation.
            var url = scenarios[0].url;
            return WinJS.Navigation.navigate(url, { searchDetails: eventObject.detail });
        }));
    }
}

JavaScript では、eventObjectwebUISearchActivatedEventArgs オブジェクトを含んでいます。

要件

最小限サポートされるクライアント

Windows 8 [Windows ストア アプリのみ]

最小限サポートされるサーバー

Windows Server 2012 [Windows ストア アプリのみ]

名前空間

Windows.UI.WebUI

メタデータ

Windows.winmd

参照

検索コントラクトのサンプル

 

 

表示:
© 2017 Microsoft