SearchSuggestionManager Class

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

Manages access to search suggestions for the in-app SearchBox control.

public ref class SearchSuggestionManager sealed

/// [Windows.Foundation.Metadata.Activatable(65536, Windows.ApplicationModel.Search.Core.SearchCoreContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.Core.SearchCoreContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class SearchSuggestionManager final

/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.Core.SearchCoreContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.ApplicationModel.Search.Core.SearchCoreContract")]
class SearchSuggestionManager final

[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.ApplicationModel.Search.Core.SearchCoreContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.Core.SearchCoreContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class SearchSuggestionManager

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.Core.SearchCoreContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.ApplicationModel.Search.Core.SearchCoreContract")]
public sealed class SearchSuggestionManager

function SearchSuggestionManager()

Public NotInheritable Class SearchSuggestionManager

Inheritance: Object Platform::Object IInspectable SearchSuggestionManager

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute

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)

Constructors

SearchSuggestionManager()

Initializes a new instance of the SearchSuggestionManager class.

Properties

SearchHistoryContext	Identifies the context of the search and is used to store the user's search history with the app.
SearchHistoryEnabled	Indicates whether the user's previous searches with the app are automatically tracked and used to provide suggestions.
Suggestions	Gets the search suggestions for the current search query.

Methods

AddToHistory(String)	Stores the specified query in the search history.
AddToHistory(String, String)	Stores the specified query and input language in the search history.
ClearHistory()	Clears all search history contexts for the current app.
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	Specifies whether suggestions based on local files are added automatically to the Suggestions collection, and defines the criteria that Windows uses to locate and filter these suggestions.
SetQuery(String)	Assigns the current search query.
SetQuery(String, String)	Assigns the current search query with the specified input language.
SetQuery(String, String, SearchQueryLinguisticDetails)	Assigns the current search query with the specified input language and Input Method Editor (IME) info.

Events

RequestingFocusOnKeyboardInput	Raised when the user presses a key that initiates type-to-search.
SuggestionsRequested	Raised when the user's query text changes and the app needs to provide new suggestions to display in the search box.

Applies to

Share via