SearchBoxSuggestionsRequestedEventArgs Classe

Définition

Espace de noms:

Windows.UI.Xaml.Controls

Fournit des données d’événement pour l’événement SearchBox.SuggestionsRequested .

public ref class SearchBoxSuggestionsRequestedEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SearchBoxSuggestionsRequestedEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchBoxSuggestionsRequestedEventArgs

Public NotInheritable Class SearchBoxSuggestionsRequestedEventArgs

Héritage

Object Platform::Object IInspectable SearchBoxSuggestionsRequestedEventArgs

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

Si vous souhaitez répondre à l’événement SuggestionsRequested de façon asynchrone, vous devez obtenir un objet SearchSuggestionsRequestDeferral avant de modifier la liste de suggestions. Voici un exemple qui montre comment procéder.

public async static void SearchBox_SuggestionsRequested(
    SearchBox sender, 
    SearchBoxSuggestionsRequestedEventArgs args)
{

    // This object lets us edit the SearchSuggestionCollection asynchronously. 
    var deferral = args.Request.GetDeferral();

    try { 

        // Retrieve the system-supplied suggestions.
        var suggestions = args.Request.SearchSuggestionCollection;

        var groups = await SampleDataSource.GetGroupsAsync();
        foreach (var group in groups)
        {
            var matchingItems = group.Items.Where(
                item => item.Title.StartsWith(
                    args.QueryText, StringComparison.CurrentCultureIgnoreCase));

            foreach (var item in matchingItems)
            {
                suggestions.AppendQuerySuggestion(item.Title);
            }
        }

        foreach (string alternative in args.LinguisticDetails.QueryTextAlternatives)
        {
            if (alternative.StartsWith(
                args.QueryText, StringComparison.CurrentCultureIgnoreCase))
            {
                suggestions.AppendQuerySuggestion(alternative); 
            }
        }
    }
    finally {
        deferral.Complete();
    }

}

Remarques

Important

Bien que la méthode SearchBox soit implémentée dans la famille d’appareils universelle, elle n’est pas entièrement fonctionnelle sur des appareils mobiles. Utilisez AutoSuggestBox pour votre expérience de recherche universelle. Voir Remplacement de SearchBox par AutoSuggestBox.

Propriétés

Language	Obtient la balise de langue IETF (Internet Engineering Task Force) (norme BCP 47) qui identifie la langue actuellement associée au périphérique d’entrée de texte de l’utilisateur.
LinguisticDetails	Obtient des informations sur le texte de requête que l’utilisateur entre par le biais d’un éditeur de méthode d’entrée (IME).
QueryText	Obtient le texte de la requête de la recherche actuelle.
Request	Obtient l’objet qui stocke les suggestions et les informations relatives à cette requête.

Voir aussi

• SuggestionsRequested