SearchPane.QuerySubmitted Event

  • Reference

Definition

Namespace:
Windows.ApplicationModel.Search
Edit

Fires when the user submits the text in the search box and the app needs to display search results.

/// [add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.ApplicationModel.Search.SearchContract)]
/// [remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.ApplicationModel.Search.SearchContract)]
// Register
event_token QuerySubmitted(TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs const&> const& handler) const;

// Revoke with event_token
void QuerySubmitted(event_token const* cookie) const;

// Revoke with event_revoker
SearchPane::QuerySubmitted_revoker QuerySubmitted(auto_revoke_t, TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs const&> const& handler) const;
/// [add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
/// [remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
// Register
event_token QuerySubmitted(TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs const&> const& handler) const;

// Revoke with event_token
void QuerySubmitted(event_token const* cookie) const;

// Revoke with event_revoker
SearchPane::QuerySubmitted_revoker QuerySubmitted(auto_revoke_t, TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs const&> const& handler) const;
[add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.ApplicationModel.Search.SearchContract))]
[remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.ApplicationModel.Search.SearchContract))]
public event TypedEventHandler<SearchPane,SearchPaneQuerySubmittedEventArgs> QuerySubmitted;
[add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
[remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
public event TypedEventHandler<SearchPane,SearchPaneQuerySubmittedEventArgs> QuerySubmitted;
function onQuerySubmitted(eventArgs) { /* Your code */ }
searchPane.addEventListener("querysubmitted", onQuerySubmitted);
searchPane.removeEventListener("querysubmitted", onQuerySubmitted);
- or -
searchPane.onquerysubmitted = onQuerySubmitted;
Public Custom Event QuerySubmitted As TypedEventHandler(Of SearchPane, SearchPaneQuerySubmittedEventArgs)

Event Type

TypedEventHandler<SearchPane,SearchPaneQuerySubmittedEventArgs>
Attributes
DeprecatedAttribute

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.

Note

An app can't use both the search box (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) 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.'"

If your app participates in the Search contract, register an event handler to respond when this event fires. In your QuerySubmitted event handler, respond by taking the user to your search results page and populating it with results based on the SearchPaneQuerySubmittedEventArgs.QueryText.

Applies to

See also