This topic has not yet been rated - Rate this topic

SearchSuggestionCollection class

Represents a collection of search suggestions to be displayed in the search pane in response to a suggestionsrequested event.

Syntax

JavaScript

C++


public ref class SearchSuggestionCollection sealed : Object

Attributes

MarshalingBehaviorAttribute(Agile)
MuseAttribute()
VersionAttribute(NTDDI_WIN8)

Members

The SearchSuggestionCollection class has these types of members:

Methods
Properties

Methods

The SearchSuggestionCollection class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Method	Description
AppendQuerySuggestion	Appends a query suggestion to the list of search suggestions for the search pane.
AppendQuerySuggestions	Appends a list of query suggestions to the list of search suggestions for the search pane.
AppendResultSuggestion	Appends a suggested search result to the list of suggestions to display in the search pane.
AppendSearchSeparator	Appends a text label that is used to separate groups of suggestions in the search pane.

Properties

The SearchSuggestionCollection class has these properties.

Property	Access type	Description
Size	Read-only	The number of suggestions in the collection.

Remarks

The search pane can display 5 suggestions, at most. Additionally, each separator you use takes the place of a suggestion and lowers the number of suggestions that you can display. Learn more about displaying suggestions in Guidelines and checklist for search.

An app retrieves this object through the searchPaneSuggestionsRequest.searchSuggestionCollection property while handling a suggestionsrequested event.

Examples

The Search contract sample demonstrates how to respond to a suggestionsrequested event, including how to use the searchSuggestionCollection.