SearchPane.SearchHistoryEnabled SearchPane.SearchHistoryEnabled SearchPane.SearchHistoryEnabled SearchPane.SearchHistoryEnabled SearchPane.SearchHistoryEnabled Property

Definition

Indicates whether the user's previous searches with the app are automatically tracked and used to provide suggestions.

public : Platform::Boolean SearchHistoryEnabled { get; set; }
bool SearchHistoryEnabled();

void SearchHistoryEnabled(bool searchhistoryenabled);
public bool SearchHistoryEnabled { get; set; }
Public ReadWrite Property SearchHistoryEnabled As bool
var bool = searchPane.searchHistoryEnabled;
searchPane.searchHistoryEnabled = bool;

Property Value

bool bool bool

True if the user's search history is automatically tracked and used to provide suggestions; otherwise false. The default value is true.

Remarks

Note

An app can't use both the search box (Windows.UI.Xaml.Controls.SearchBox for UWP app using C++, C#, or Visual Basic, WinJS.UI.SearchBox for Windows app using JavaScript) and the SearchPane. Using both the search box and the search pane in the same app causes the app to throw an exception with this message: "Cannot create instance of type 'Windows.UI.Xaml.Controls.SearchBox.'"

You can set this property to false to opt out of automatic suggestions; your app can optionally provide its own suggestions to users instead. If you decide to have your app track its own search history, you should also give the user some control over their history through the Settings charm, like the ability to clear the history.

If you set this property while the search pane is open, the change won't take effect until the user enters the next character of their query.

See also