SearchPaneSuggestionsRequestedEventArgs, classe

SearchPaneSuggestionsRequestedEventArgs Class

Fournit des données pour un événement suggestionsrequested qui est associé à un objet searchPane.

Syntaxe


/* Pour plus d'informations sur la création ou l'accès à cet objet, consultez les notes. */

Attributs

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

Membres

SearchPaneSuggestionsRequestedEventArgsClasse possède ces types de membres :

Méthodes

The SearchPaneSuggestionsRequestedEventArgs Classe hérite des méthodes de Object Classe (C#/VB/C++).

Propriétés

Le SearchPaneSuggestionsRequestedEventArgsClasse a les propriétés suivantes.

PropriétéType d'accèsDescription

Language

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

LinguisticDetails

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

QueryText

En lecture seuleThe text that the app should provide suggestions for and that was in the search box when the suggestionsrequested event fired.

Request

En lecture seuleAn object that stores suggestions and information about the request.

 

Remarques

Cet objet est passé au gestionnaire d'événements suggestionsrequested d'une application.

Utilisez votre application pour envoyer des suggestions

Il existe différentes manières d'obtenir des suggestions pour votre application :

  • À partir d'une liste locale statique définie par l'application
  • À partir d'une URL qui prend en charge les suggestions au format OpenSearch
  • À partir d'une URL qui prend en charge les suggestions au format XML

Après avoir obtenu des suggestions, vous devez les ajouter à la collection de suggestions à afficher pour la requête d'utilisateur. Accédez à cette collection avec la propriété searchPaneSuggestionsRequest.searchSuggestionCollection.

Remarque  Si vous souhaitez fournir des suggestions de résultats, vous devez écouter et gérer l'événement resultsuggestionchosen.

Exemples

L'Exemple de contrat de recherche montre comment répondre à un événement suggestionsrequested.

Remarque  Vous pouvez accéder aux informations relatives à l'événement de l'objet searchPaneSuggestionsRequestedEventArgs passé à votre gestionnaire suggestionsrequested.


// Register the onsuggestionsrequested event in your apps global scope, for example default.js, so that it is registered as soon as your app is launched.
Windows.ApplicationModel.Search.SearchPane.getForCurrentView().onsuggestionsrequested = function (eventObject) {
    var queryText = eventObject.queryText, suggestionRequest = eventObject.request, linguisticDetails = eventObject.linguisticDetails;

    var queryAlternatives = linguisticDetails.queryTextAlternatives;
    var maxNumberOfSuggestions = 5;
    for (var i = 0, len = queryAlternatives.length, done = false; i < len && !done; i++) {
        // toLowerCase not necessary for East Asian languages. Preserves compatibility when non East Asian suggestions are mixed in with East Asian suggestions.
        var alternative = queryAlternatives[i].toLowerCase();
        for (var j = 0, suggestionLength = suggestionList.length; j < suggestionLength; j++) {
            if (suggestionList[j].substr(0, alternative.length).toLowerCase() === alternative) {
                suggestionRequest.searchSuggestionCollection.appendQuerySuggestion(suggestionList[j]);
                if (suggestionRequest.searchSuggestionCollection.size === maxNumberOfSuggestions) {
                    done = true;
                    break;
                }
            }
        }
    }

    // Construct list of alternatives so we can output them.
    var alternatives = "";
    for (var k = 0, alternativeCount = queryAlternatives.length; k < alternativeCount; k++) {
        alternatives += queryAlternatives[k];
    }
    if (suggestionRequest.searchSuggestionCollection.size > 0) {
        WinJS.log && WinJS.log("Suggestions provided for query: " + queryText + "\nUsing alternatives: " + alternatives, "sample", "status");
    } else {
        WinJS.log && WinJS.log("No suggestions provided for query: " + queryText + "\nUsing alternatives: " + alternatives, "sample", "status");
    }
};


Pour les développeurs C#, l'exemple de contrat de recherche montre également comment s'inscrire à un événement SuggestionsRequested via SearchPane.


searchPane.SuggestionsRequested += new TypedEventHandler<SearchPane, SearchPaneSuggestionsRequestedEventArgs>(OnSearchPaneSuggestionsRequested);

Conditions requises

Client minimal pris en charge

Windows 8 [Applications Windows Store uniquement]

Serveur minimal pris en charge

Windows Server 2012 [Applications Windows Store uniquement]

Espace de noms

Windows.ApplicationModel.Search
Windows::ApplicationModel::Search [C++]

Métadonnées

Windows.winmd

Voir aussi

Exemple de contrat de recherche
Instructions et liste de contrôle pour la recherche
Référence
SearchPane class
SearchPane.ResultSuggestionChosen event
SearchPane.SuggestionsRequested event
SearchSuggestionCollection class
SearchPaneSuggestionsRequestedEventArgs class
SearchPaneSuggestionsRequest.SearchSuggestionCollection property

 

 

Afficher:
© 2017 Microsoft