Partager via


SearchSuggestionManager.SuggestionsRequested Événement

Définition

Déclenché lorsque le texte de la requête de l’utilisateur change et que l’application doit fournir de nouvelles suggestions à afficher dans la zone de recherche.

// Register
event_token SuggestionsRequested(TypedEventHandler<SearchSuggestionManager, SearchSuggestionsRequestedEventArgs const&> const& handler) const;

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

// Revoke with event_revoker
SearchSuggestionManager::SuggestionsRequested_revoker SuggestionsRequested(auto_revoke_t, TypedEventHandler<SearchSuggestionManager, SearchSuggestionsRequestedEventArgs const&> const& handler) const;
public event TypedEventHandler<SearchSuggestionManager,SearchSuggestionsRequestedEventArgs> SuggestionsRequested;
function onSuggestionsRequested(eventArgs) { /* Your code */ }
searchSuggestionManager.addEventListener("suggestionsrequested", onSuggestionsRequested);
searchSuggestionManager.removeEventListener("suggestionsrequested", onSuggestionsRequested);
- or -
searchSuggestionManager.onsuggestionsrequested = onSuggestionsRequested;
Public Custom Event SuggestionsRequested As TypedEventHandler(Of SearchSuggestionManager, SearchSuggestionsRequestedEventArgs) 

Type d'événement

Remarques

Les suggestions peuvent provenir de trois sources : historique de recherche, fichiers locaux ou d’une source spécifiée par l’application. Les suggestions sont regroupées par source et s’affichent dans l’ordre suivant dans le volet de recherche : historique des recherches, fichiers locaux, puis sources spécifiées par l’application.

Si votre application participe au contrat de recherche et que vous souhaitez que votre application affiche des suggestions provenant de sources que vous spécifiez, vous devez inscrire un gestionnaire pour répondre lorsque cet événement se déclenche. Dans votre gestionnaire d’événements SuggestionsRequested, répondez en obtenant des suggestions et en remplissant le SearchSuggestionCollection en fonction du QueryText de l’utilisateur.

Notes

Si vous souhaitez répondre à cet événement de manière asynchrone, vous devez obtenir un report à partir de la propriété Request .

Les suggestions ne pouvant pas être fournies pour une zone de recherche vide, cet événement n’est pas déclenché lorsque l’utilisateur met à jour la zone de recherche pour qu’elle soit vide.

Types de suggestions de recherche

Il existe deux types de suggestions que votre application peut afficher : les suggestions qui aident les utilisateurs à affiner une requête (suggestions de requête) et les suggestions qui sont des résultats réels d’une requête (suggestions de résultats). Vous pouvez choisir d’afficher l’un ou l’autre des types de suggestions.

Si vous fournissez des suggestions de requête et que l’utilisateur en sélectionne une, votre application doit répondre en affichant les résultats de la requête sélectionnée et affinée dans la page des résultats de recherche de votre application.

Si vous fournissez des suggestions de résultats, vous devez également inscrire un gestionnaire d’événements ResultSuggestionChosen afin de pouvoir répondre lorsque l’utilisateur sélectionne l’une de vos suggestions de résultats et vous pouvez afficher le résultat à l’utilisateur.

Obtention de suggestions

Voici quelques exemples de sources que votre application peut utiliser pour obtenir des suggestions :

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

Affichage des suggestions fournies par l’application dans le contrôle de zone de recherche

Une fois que vous avez obtenu des suggestions, vous les affichez dans le volet de recherche en les ajoutant à searchSuggestionCollection de la demande.

Si vous choisissez d’afficher les suggestions de requête et les suggestions de résultats, vous devez regrouper les suggestions par type de suggestion (requête ou résultat) et séparer les groupes à l’aide d’AppendSearchSeparator. Chaque séparateur prend la place d’une suggestion et doit être suivi d’au moins une suggestion, ce qui réduit le nombre de suggestions que vous pouvez afficher.

S’applique à

Voir aussi