SearchSuggestionsRequest Class

Definition

Namespace:

Windows.ApplicationModel.Search

Stores suggestions and information about the request for suggestions.

public ref class SearchSuggestionsRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SearchSuggestionsRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchSuggestionsRequest

Public NotInheritable Class SearchSuggestionsRequest

Inheritance

Object Platform::Object IInspectable SearchSuggestionsRequest

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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.

If your app provides its own suggestions to display in the search pane or in-app search box, use the SearchSuggestionCollection property to add your app's suggestions to the collection of suggestions to display.

Properties

IsCanceled	Indicates whether the request for suggestions to display is canceled.
SearchSuggestionCollection	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.

Methods

GetDeferral()

Gets an object that lets an app respond to a request for suggestions asynchronously.