SearchPane クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
非推奨になりました。 代わりに 、Windows.UI.Xaml.Controls.AutoSuggestBox コントロールを使用します。 ユーザーが検索チャームをアクティブ化したときに開く検索ウィンドウを表し、管理します。
public ref class SearchPane sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.SearchContract, 65536)]
/// [Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.ApplicationModel.Search.SearchContract)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class SearchPane final/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.SearchContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
class SearchPane final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.SearchContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.ApplicationModel.Search.SearchContract))]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class SearchPane[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.SearchContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
public sealed class SearchPanePublic NotInheritable Class SearchPane- 継承
- 属性
Windows の要件
| デバイス ファミリ |
Windows Desktop Extension SDK (10.0.10240.0 で導入)
Xbox One Extensions for the UWP (10.0.10586.0 で導入) |
| API contract |
Windows.ApplicationModel.Search.SearchContract (v1.0 で導入)
|
注釈
重要
Windows 10以降の検索をアプリに実装するには、AutoSuggestBox を使用します。 詳細については、「 自動提案ボックス 」を参照してください。
Windows 10 以降のアプリでは、Windows.ApplicationModel.Search API (SearchPane、SearchContract) または SearchBox API を使用しないでください。
Note
アプリでは、検索ボックス (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) と SearchPane の両方を使用することはできません。 同じアプリで検索ボックスと検索ウィンドウの両方を使用すると、"型 'Windows.UI.Xaml.Controls.SearchBox.' のインスタンスを作成できません"というメッセージでアプリが例外をスローします。
このオブジェクトは、検索コントラクトに参加するアプリで使用できます。 ユーザーに検索結果を提供するには、アプリが検索用にアクティブ化されたときに応答するコードを Activated イベント ハンドラーに追加する必要があります。 Search アクティブ化イベントへの応答の詳細については、「webUISearchActivatedEventArgs (JavaScript)」または「SearchActivatedEventArgs (C#/C++/VB)」を参照してください。
検索イベントに応答し、検索ウィンドウを管理する方法を示すコード例は、検索コントラクト サンプル (Windows 8) で確認できます。
プロパティ
| Language |
ユーザーのテキスト入力デバイスに現在関連付けられている言語を識別するインターネット エンジニアリング タスク フォース (IETF) 言語タグ (BCP 47 標準)。 |
| PlaceholderText |
ユーザーが文字を入力していない場合の検索ボックス内のプレースホルダー テキスト。 |
| QueryText |
検索ウィンドウの検索ボックス内の現在のテキスト。 |
| SearchHistoryContext |
検索のコンテキストを識別し、アプリでユーザーの検索履歴を格納するために使用される文字列。 |
| SearchHistoryEnabled |
アプリを使用したユーザーの以前の検索が自動的に追跡され、提案を提供するために使用されるかどうかを示します。 |
| ShowOnKeyboardInput |
ユーザーが入力して検索ウィンドウを開くことができるかどうかを取得または設定します。 |
| Visible |
検索ウィンドウが開いているかどうかを示します。 |
メソッド
| GetForCurrentView() |
ユーザーがアプリ内で検索できる検索ウィンドウのインスタンスを取得します。 |
| HideThisApplication() |
現在のアプリの UI を非表示にします。 |
| SetLocalContentSuggestionSettings(LocalContentSuggestionSettings) |
ローカル ファイルに基づく候補を検索ウィンドウに自動的に表示するかどうかを指定し、これらの候補を検索およびフィルター処理するために Windows が使用する条件を定義します。 |
| Show() |
検索ウィンドウを表示します。 |
| Show(String) |
指定した最初のクエリ文字列を含む検索ウィンドウを表示します。 |
| TrySetQueryText(String) |
検索ウィンドウの検索ボックスにテキストを設定しようとします。 |
イベント
| QueryChanged |
ユーザーが検索ボックスのテキストを変更すると発生します。 |
| QuerySubmitted |
ユーザーが検索ボックスのテキストを送信し、アプリで検索結果を表示する必要がある場合に発生します。 |
| ResultSuggestionChosen |
ユーザーが、アプリによって提供され、検索ウィンドウに表示された推奨結果のいずれかを選択すると発生します。 |
| SuggestionsRequested |
ユーザーのクエリ テキストが変更され、アプリが検索ウィンドウに表示する新しい候補を提供する必要がある場合に発生します。 |
| VisibilityChanged |
ユーザーが検索ウィンドウを開くか閉じるときに発生します。 |