SearchSuggestionCollection.AppendResultSuggestion メソッド

  • リファレンス

定義

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

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

public:
 virtual void AppendResultSuggestion(Platform::String ^ text, Platform::String ^ detailText, Platform::String ^ tag, IRandomAccessStreamReference ^ image, Platform::String ^ imageAlternateText) = AppendResultSuggestion;
void AppendResultSuggestion(winrt::hstring const& text, winrt::hstring const& detailText, winrt::hstring const& tag, IRandomAccessStreamReference const& image, winrt::hstring const& imageAlternateText);
public void AppendResultSuggestion(string text, string detailText, string tag, IRandomAccessStreamReference image, string imageAlternateText);
function appendResultSuggestion(text, detailText, tag, image, imageAlternateText)
Public Sub AppendResultSuggestion (text As String, detailText As String, tag As String, image As IRandomAccessStreamReference, imageAlternateText As String)

パラメーター

text
String

Platform::String

winrt::hstring

提案された結果のテキスト。

detailText
String

Platform::String

winrt::hstring

提案された結果の詳細テキスト。

tag
String

Platform::String

winrt::hstring

この推奨結果を識別する一意のタグ。

この提案された結果がユーザーによって選択されると、 ResultSuggestionChosen イベントが発生します。 アプリはこのイベントを処理するときに、 SearchPaneResultSuggestionChosenEventArgs.Tag プロパティから選択した結果候補のタグを取得できます。

image
IRandomAccessStreamReference

結果の提案に付随する画像。 イメージは 40 x 40 にする必要があります。 Windows では、小さい画像または大きな画像を拡大縮小またはトリミングします。

imageAlternateText
String

Platform::String

winrt::hstring

画像の代替テキスト。

注釈

重要

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

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

クエリ候補の代わりに結果候補を使用する必要があるのは、検索結果を表示するビューではなく、ユーザーをアイテムに直接連れて行く信頼度の高い結果を表示する場合のみです。

提案された結果には、検索ウィンドウに候補と共に表示する画像とオプションの詳細テキストが含まれます。 この画像は、クエリ候補ではなく、結果が表示されていることをユーザーに通知します。 結果のイメージが存在しない場合は、結果または結果の種類を表す汎用イメージまたはアイコンを使用できます。

結果の候補を提供する場合は、 ResultSuggestionChosen イベントをリッスンして処理する必要があります。

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

適用対象

こちらもご覧ください