SearchSuggestionCollection クラス

  • リファレンス

定義

名前空間:
Windows.ApplicationModel.Search
編集

suggestionsrequested イベントに応答して検索ウィンドウに表示される検索候補のコレクションを表します。

public ref class SearchSuggestionCollection sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SearchSuggestionCollection final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchSuggestionCollection
Public NotInheritable Class SearchSuggestionCollection
継承
Object Platform::Object IInspectable SearchSuggestionCollection
属性
ContractVersionAttribute MarshalingBehaviorAttribute

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v1.0 で導入)

注釈

重要

Windows 10以降の検索をアプリに実装するには、AutoSuggestBox を使用します。 詳細については、「 自動提案ボックス 」を参照してください。

Windows 10 以降のアプリでは、Windows.ApplicationModel.Search API (SearchPane、SearchContract) または SearchBox API を使用しないでください。

検索ウィンドウには、最大で 5 つの候補を表示できます。 さらに、使用する各区切り記号は候補の代わりに使用され、表示できる候補の数が減ります。

SuggestionsRequested イベントの処理中に、アプリは SearchPaneSuggestionsRequest.searchSuggestionCollection プロパティを使用してこのオブジェクトを取得します。

プロパティ

Size

コレクション内の候補の数。

メソッド

AppendQuerySuggestion(String)

検索ウィンドウの検索候補の一覧にクエリ候補を追加します。
AppendQuerySuggestions(IIterable<String>)

検索ウィンドウの検索候補の一覧にクエリ候補の一覧を追加します。
AppendResultSuggestion(String, String, String, IRandomAccessStreamReference, String)

検索ウィンドウに表示する候補の一覧に、提案された検索結果を追加します。
AppendSearchSeparator(String)

検索ウィンドウで候補のグループを分離するために使用されるテキスト ラベルを追加します。

適用対象

こちらもご覧ください