Windows Dev Center

SearchPaneSuggestionsRequest.SearchSuggestionCollection | searchSuggestionCollection property

The suggestions to display in the search pane for the current query. Apps provide suggestions to display by appending them to this searchSuggestionCollection object.

Syntax


var searchSuggestionCollection = searchPaneSuggestionsRequest.searchSuggestionCollection;

Property value

Type: SearchSuggestionCollection

The suggestions to display. Apps provide suggestions by appending them to this searchSuggestionCollection object.

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.

Use the SearchSuggestionCollection object to append app-provided suggestions and search separators to display in the search pane.

When the request for suggestions is completed, either by returning from the suggestionsrequested event handler or by calling searchPaneSuggestionsRequestDeferral.complete, the search pane displays the suggestions in the searchSuggestionCollection.

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.ApplicationModel.Search
Windows::ApplicationModel::Search [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

None supported

Namespace

Windows.ApplicationModel.Search
Windows::ApplicationModel::Search [C++]

Metadata

Windows.winmd

See also

Reference
SearchPane.SuggestionsRequested event
SearchPaneSuggestionsRequest class
SearchPaneSuggestionsRequest.GetDeferral method
SearchPaneSuggestionsRequestDeferral class
SearchPaneSuggestionsRequestedEventArgs class

 

 

Show:
© 2015 Microsoft