SearchPane.SuggestionsRequested Événement

Définition

Espace de noms:

Windows.ApplicationModel.Search

Se produit lorsque le texte de la requête de l’utilisateur change et que l’application doit fournir de nouvelles suggestions à afficher dans le volet de recherche.

/// [add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
/// [remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
// Register
event_token SuggestionsRequested(TypedEventHandler<SearchPane, SearchPaneSuggestionsRequestedEventArgs const&> const& handler) const;

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

// Revoke with event_revoker
SearchPane::SuggestionsRequested_revoker SuggestionsRequested(auto_revoke_t, TypedEventHandler<SearchPane, SearchPaneSuggestionsRequestedEventArgs const&> const& handler) const;

[add: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
[remove: Windows.Foundation.Metadata.Deprecated("ISearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
public event TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs> SuggestionsRequested;

function onSuggestionsRequested(eventArgs) { /* Your code */ }
searchPane.addEventListener("suggestionsrequested", onSuggestionsRequested);
searchPane.removeEventListener("suggestionsrequested", onSuggestionsRequested);
- or -
searchPane.onsuggestionsrequested = onSuggestionsRequested;

Public Custom Event SuggestionsRequested As TypedEventHandler(Of SearchPane, SearchPaneSuggestionsRequestedEventArgs) 

Type d'événement

TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs>

Attributs

DeprecatedAttribute

Remarques

Important

Pour implémenter la recherche dans une application pour Windows 10 ou une version ultérieure, utilisez AutoSuggestBox. Pour plus d’informations, consultez la zone Suggestion automatique.

Vous ne devez pas utiliser les API Windows.ApplicationModel.Search (SearchPane, SearchContract) ou les API SearchBox dans les applications pour Windows 10 ou une version ultérieure.

Notes

Une application ne peut pas utiliser à la fois la zone de recherche (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) et le SearchPane. L’utilisation de la zone de recherche et du volet de recherche dans la même application entraîne la levée d’une exception avec ce message : « Impossible de créer instance de type 'Windows.UI.Xaml.Controls.SearchBox.' »

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

Si votre application participe au contrat de recherche et que vous souhaitez qu’elle 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 searchSuggestionCollection en fonction du SearchPaneSuggestionsRequestedEventArgs de l’utilisateur. QueryText.

Notes

Si vous souhaitez répondre à cet événement de manière asynchrone, vous devez utiliser SearchPaneSuggestionsRequestedEventArgs. Demande. GetDeferral.

Les suggestions ne peuvent pas être fournies pour une zone de recherche vide. Cet événement n’est donc 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 pour pouvoir répondre lorsque l’utilisateur sélectionne l’une de vos suggestions de résultats et 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 volet de recherche

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

Au maximum, le volet de recherche peut afficher 5 suggestions. Si vous choisissez d’afficher des suggestions de requête et des 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.

Voir aussi

• SearchPane
• ResultSuggestionChosen
• SearchSuggestionCollection
• SearchPaneSuggestionsRequestedEventArgs
• SearchSuggestionCollection
• Exemple de contrat de recherche (Windows 8)