SearchPaneQuerySubmittedEventArgs SearchPaneQuerySubmittedEventArgs SearchPaneQuerySubmittedEventArgs SearchPaneQuerySubmittedEventArgs Class

Provides data for a QuerySubmitted event that is associated with a SearchPane instance.

Syntax

Declaration

public sealed class SearchPaneQuerySubmittedEventArgspublic sealed class SearchPaneQuerySubmittedEventArgsPublic NotInheritable Class SearchPaneQuerySubmittedEventArgspublic sealed class SearchPaneQuerySubmittedEventArgs

Remarks

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

Examples

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

Note

You can access information about the event from the SearchPaneQuerySubmittedEventArgs object that is passed to your QuerySubmitted event handler.

// Register QuerySubmitted handler for the window at window creation time and only registered once
// so that the app can receive user queries at any time.
SearchPane.GetForCurrentView().QuerySubmitted += new TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs>(OnQuerySubmitted);
Windows.ApplicationModel.Search.SearchPane.getForCurrentView().onquerysubmitted = function (eventObject) {
    WinJS.log && WinJS.log("User submitted the search query: " + eventObject.queryText, "sample", "status");
};

Properties summary

The Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

An object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME).

The text that was submitted through the search pane.

Properties

  • Language
    Language
    Language
    Language

    The Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

    public string Language { get; }public string Language { get; }Public ReadOnly Property Language As stringpublic string Language { get; }

    Property Value

    • string
      string
      string
      string

      The Internet Engineering Task Force (IETF) BCP 47 standard language tag.

  • LinguisticDetails
    LinguisticDetails
    LinguisticDetails
    LinguisticDetails

    An object that provides linguistic information about query text that the user is entering through an Input Method Editor (IME).

    public SearchPaneQueryLinguisticDetails LinguisticDetails { get; }public SearchPaneQueryLinguisticDetails LinguisticDetails { get; }Public ReadOnly Property LinguisticDetails As SearchPaneQueryLinguisticDetailspublic SearchPaneQueryLinguisticDetails LinguisticDetails { get; }

    Property Value

  • QueryText
    QueryText
    QueryText
    QueryText

    The text that was submitted through the search pane.

    public string QueryText { get; }public string QueryText { get; }Public ReadOnly Property QueryText As stringpublic string QueryText { get; }

    Property Value

    • string
      string
      string
      string

      The submitted query text.

Device family

Windows Desktop Extension SDK (introduced v10.0.10240.0)
Xbox One Extensions for the UWP (introduced v10.0.10586.0)

API contract

Windows.ApplicationModel.Search.SearchContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DeprecatedAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.ApplicationModel.Search.dll