SearchPaneResultSuggestionChosenEventArgs Class

Definition

Provides data for a resultsuggestionchosen event that is associated with a searchPane object.

public ref class SearchPaneResultSuggestionChosenEventArgs sealed
class SearchPaneResultSuggestionChosenEventArgs sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.SearchContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("SearchPaneResultSuggestionChosenEventArgs may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.ApplicationModel.Search.SearchContract))]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchPaneResultSuggestionChosenEventArgs
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.SearchContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Deprecated("SearchPaneResultSuggestionChosenEventArgs may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
public sealed class SearchPaneResultSuggestionChosenEventArgs
Public NotInheritable Class SearchPaneResultSuggestionChosenEventArgs
Inheritance
SearchPaneResultSuggestionChosenEventArgs
Attributes

Windows 10 requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
Xbox One Extensions for the UWP (introduced in 10.0.10586.0)
API contract
Windows.ApplicationModel.Search.SearchContract (introduced in v1.0)

Examples

The Search contract sample demonstrates how to register a resultsuggestionchosen event handler.

Note

You can get information about the event from the searchPaneResultSuggestionChosenEventArgs object that is passed to your resultsuggestionchosen event handler.

searchPane.ResultSuggestionChosen += new TypedEventHandler<SearchPane, SearchPaneResultSuggestionChosenEventArgs>(OnResultSuggestionChosen);
Windows.ApplicationModel.Search.SearchPane.getForCurrentView().onresultsuggestionchosen = function (eventObject) {
    WinJS.log && WinJS.log("Result Suggestion Selected with Tag: " + eventObject.tag, "sample", "status");
};

Remarks

This object is passed to an app's resultsuggestionchosen event handler.

Properties

Tag

The tag for the suggested result that the user selected.

Applies to

See also