SearchSuggestionKind Enum

Reference

Definition

Namespace:: Windows.ApplicationModel.Search.Core

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Specifies the type of a SearchSuggestion.

public enum class SearchSuggestionKind

/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.Core.SearchCoreContract, 65536)]
enum class SearchSuggestionKind

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.Core.SearchCoreContract), 65536)]
public enum SearchSuggestionKind

var value = Windows.ApplicationModel.Search.Core.SearchSuggestionKind.query

Public Enum SearchSuggestionKind

Inheritance: Enum
SearchSuggestionKind

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.10240.0)
API contract	Windows.ApplicationModel.Search.Core.SearchCoreContract (introduced in v1.0)

Fields

Query	0	The suggestion is a query suggestion.
Result	1	The suggestion is a result suggestion.
Separator	2	Represents a separator between search suggestions that's useful for grouping.

Remarks

Use result suggestions instead of query suggestions only to display high-confidence results that take the user directly to the item instead of to a view that shows search results.

Suggested results include an image and optional detail text to display with the suggestion in the search pane. The image signals to the user that they are seeing results and not query suggestions. If an image for the result doesn't exist, you can use a generic image or icon that represents the result or result type.

Handle the SuggestionsRequested event to provide result suggestions.

Types of search suggestions

There are two types of suggestions your app can display: suggestions that help users refine a query (query suggestions), and suggestions that are actual results of a query (result suggestions). You may choose to display either or both types of suggestions.

If you provide query suggestions and the user selects one, your app should respond by displaying results for the selected, refined query in your app's search results page.

If you provide result suggestions, you must also register a ResultSuggestionChosen event handler so that you can respond when the user selects one of your result suggestions and you can display the result to the user.

Applies to

Share via