SearchPane, classe
Réduire la table des matières
Développer la table des matières

SearchPane Class

Représente et gère le volet de recherche qui s'ouvre lorsque les utilisateurs activent l'orthographe de recherche. Le volet de recherche fournit une zone de recherche cohérente et conviviale, ainsi que des suggestions de recherche facultatives.

Remarque  Une application ne peut pas utiliser la zone de recherche (Windows.UI.Xaml.Controls.SearchBox pour les applications Windows Store en C++, C#, ou Visual Basic, WinJS.UI.SearchBox pour les applications Windows Store à l'aide de JavaScript) et la classe SearchPane. Si vous utilisez la zone de recherche et le volet de recherche dans la même application, l'application lève une exception avec ce message : « Impossible de créer l'instance de type "Windows.UI.Xaml.Controls.SearchBox" ».

Syntaxe


var searchPane = Windows.ApplicationModel.Search.SearchPane.getForCurrentView();

Attributs

[MarshalingBehavior(Standard)]
[Muse()]
[Version(0x06020000)]

Membres

SearchPaneClasse possède ces types de membres :

Événements

SearchPaneClasse possède ces événements.

ÉvénementDescription
QueryChanged Fires when the user changes the text in the search box.
QuerySubmitted Fires when the user submits the text in the search box and the app needs to display search results.
ResultSuggestionChosen Fires when the user selects one of the suggested results that was provided by the app and displayed in the search pane.
SuggestionsRequested Fires when the user's query text changes and the app needs to provide new suggestions to display in the search pane.
VisibilityChanged Fires when the user opens or closes the search pane.

 

Méthodes

The SearchPane Classe a les méthodes suivantes. Avec C#, Visual Basic et C++, elle hérite également des méthodes de Object Classe.

MéthodeDescription
GetForCurrentView Retrieves an instance of the search pane from which users can search within the app.
HideThisApplication Hides the current app's UI.
SetLocalContentSuggestionSettings Specifies whether suggestions based on local files are automatically displayed in the search pane, and defines the criteria that Windows uses to locate and filter these suggestions.
Show() Shows the search pane.
Show(String) Shows the search pane with the specified initial query string.
TrySetQueryText Attempts to set the text in the search box of the search pane.

 

Propriétés

Le SearchPaneClasse 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.

PlaceholderText

Lecture/écritureThe placeholder text in the search box when the user hasn't entered any characters.

QueryText

En lecture seuleThe current text in the search box of the search pane.

SearchHistoryContext

Lecture/écritureA string that identifies the context of the search and is used to store the user's search history with the app.

SearchHistoryEnabled

Lecture/écritureIndicates whether the user's previous searches with the app are automatically tracked and used to provide suggestions.

ShowOnKeyboardInput

Lecture/écritureGets or sets whether the user can open the search pane by typing.

Visible

En lecture seuleIndicates whether the search pane is open.

 

Remarques

Cet objet est disponible pour les applications qui participent au contrat de recherche. Pour en savoir plus sur l'ajout du contrat de recherche à votre application, consultez Démarrage rapide : ajout d'une recherche. Pour fournir aux utilisateurs les résultats de la recherche, vous devez ajouter du code à votre gestionnaire d'événements activé qui répond lorsque votre application est activée pour la recherche. Pour en savoir plus sur la réponse aux événements de lancement de search, consultez webUISearchActivatedEventArgs (JavaScript) ou SearchActivatedEventArgs (C#/C++/VB).

Vous pouvez consulter des exemples de code qui montrent comment répondre aux événements de recherche et gérer le volet de recherche dans l'Exemple de contrat de recherche.

Exemples

Pour C#/C++/VB : cet exemple montre comment vérifier que votre application peut répondre aux requêtes d'utilisateur à tout moment en substituant OnWindowCreated dans App.xaml.cs/App.xaml.cpp/App.xaml.vb pour accéder à l'objet SearchPane et inscrire des gestionnaires pour les événements SearchPane (comme QuerySubmitted).


protected override void OnWindowCreated(WindowCreatedEventArgs args)
{
    // At window creation time, access the SearchPane object and register SearchPane events
    // (like QuerySubmitted, SuggestionsRequested, and ResultSuggestionChosen) so that the app
    // can respond to the user's search queries at any time.

    // Get search pane
    Windows.ApplicationModel.Search.SearchPane searchPane = SearchSearchPane.GetForCurrentView();
    
    // Register event handlers for SearchPane events

    // Register QuerySubmitted event handler
    searchPane.QuerySubmitted += new TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs>(OnQuerySubmitted);
    
    // Register a SuggestionsRequested if your app displays its own suggestions in the search pane (like from a web service)
    // Register a ResultSuggestionChosen if your app uses result suggestions in the search pane    
}

Pour JavaScript : Cet exemple montre comment accéder à searchPane pour enregistrer un gestionnaire d'événements querysubmitted .

Remarque  Pour que votre application puisse répondre aux requêtes d'utilisateur à tout moment, vérifiez que vos gestionnaires d'événements searchPane sont enregistrés dans la portée globale de votre application.



// Register event handler for QuerySubmitted
Windows.ApplicationModel.Search.SearchPane.getForCurrentView().onquerysubmitted = function (eventObject) {
    // Respond to query and perform search
};

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
Démarrage rapide : ajout de la recherche
Comment traiter l'activation d'une application (JS)
Procédure d'activation d'une application (C#/C++/VB)
Référence
SearchPane.GetForCurrentView method
Windows.ApplicationModel.Activation.ActivationKind enum
Windows.ApplicationModel.Activation.SearchActivatedEventArgs class
Windows.ApplicationModel.Core.CoreApplicationView.Activated event

 

 

Afficher:
© 2017 Microsoft