SearchSuggestionsRequestedEventArgs SearchSuggestionsRequestedEventArgs SearchSuggestionsRequestedEventArgs SearchSuggestionsRequestedEventArgs Class

Definition

Provides data for the SuggestionsRequested event.

public : sealed class SearchSuggestionsRequestedEventArgs : ISearchSuggestionsRequestedEventArgspublic sealed class SearchSuggestionsRequestedEventArgs : ISearchSuggestionsRequestedEventArgsPublic NotInheritable Class SearchSuggestionsRequestedEventArgs Implements ISearchSuggestionsRequestedEventArgs// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.ApplicationModel.Search.Core.SearchCoreContract (introduced v1)

Remarks

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

Use your app to provide suggestions

There are a few different ways you can get suggestions for your app to provide:

  • From an app-defined, static, local list
  • From a URL that supports suggestions in OpenSearch format
  • From a URL that supports suggestions in XML format

Properties

Language Language Language Language

Gets 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 : PlatForm::String Language { get; }public string Language { get; }Public ReadOnly Property Language As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

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

LinguisticDetails LinguisticDetails LinguisticDetails LinguisticDetails

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

public : SearchQueryLinguisticDetails LinguisticDetails { get; }public SearchQueryLinguisticDetails LinguisticDetails { get; }Public ReadOnly Property LinguisticDetails As SearchQueryLinguisticDetails// You can use this property in JavaScript.
Value
SearchQueryLinguisticDetails SearchQueryLinguisticDetails SearchQueryLinguisticDetails SearchQueryLinguisticDetails

An object that provides linguistic information about the query text.

QueryText QueryText QueryText QueryText

The text that the app should provide suggestions for and that was in the search box when the SuggestionsRequested event was raised.

public : PlatForm::String QueryText { get; }public string QueryText { get; }Public ReadOnly Property QueryText As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The query text that the app should provide suggestions for.

Request Request Request Request

Gets an object that stores suggestions and information about the request.

public : SearchSuggestionsRequest Request { get; }public SearchSuggestionsRequest Request { get; }Public ReadOnly Property Request As SearchSuggestionsRequest// You can use this property in JavaScript.
Value
SearchSuggestionsRequest SearchSuggestionsRequest SearchSuggestionsRequest SearchSuggestionsRequest

The object that stores suggestions and information about the request.