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

标识此建议结果的唯一标记。

如果用户选择了此建议结果，则会发生 ResultSuggestion Selected 事件。 当应用处理此事件时，它可以从 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 条建议。 此外，使用的每个分隔符将取代建议，并降低可以显示的建议数。

适用于

另请参阅