SearchSuggestionsRequest.SearchSuggestionCollection Property

Definition

Namespace:

Windows.ApplicationModel.Search

Gets the suggestions to display in the search pane or in-app search box for the current query. Apps provide suggestions to display by appending them to this SearchSuggestionCollection object.

public:
 property SearchSuggestionCollection ^ SearchSuggestionCollection { SearchSuggestionCollection ^ get(); };

SearchSuggestionCollection SearchSuggestionCollection();

public SearchSuggestionCollection SearchSuggestionCollection { get; }

var searchSuggestionCollection = searchSuggestionsRequest.searchSuggestionCollection;

Public ReadOnly Property SearchSuggestionCollection As SearchSuggestionCollection

Property Value

SearchSuggestionCollection

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

Remarks

Important

To implement search in an app for Windows 10 or later, use AutoSuggestBox. See Auto-suggest box for more info.

You should not use Windows.ApplicationModel.Search APIs (SearchPane, SearchContract) or SearchBox APIs in apps for Windows 10 or later.

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

When the request for suggestions is completed, either by returning from the SuggestionsRequested event handler or by calling Complete, the search pane or in-app search box displays the suggestions in the SearchSuggestionCollection.