SearchPane Classe

Définition

Espace de noms:

Windows.ApplicationModel.Search

Action déconseillée. Utilisez le contrôle Windows.UI.Xaml.Controls.AutoSuggestBox à la place. Représente et gère le volet de recherche qui s’ouvre lorsqu’un utilisateur active l’icône Rechercher.

public ref class SearchPane sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.SearchContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
class SearchPane final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Search.SearchContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.ApplicationModel.Search.SearchContract")]
public sealed class SearchPane

Public NotInheritable Class SearchPane

Héritage

Object Platform::Object IInspectable SearchPane

Attributs

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows Desktop Extension SDK (introduit dans 10.0.10240.0) Xbox One Extensions for the UWP (introduit dans 10.0.10586.0)
API contract	Windows.ApplicationModel.Search.SearchContract (introduit dans v1.0)

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 une instance de type 'Windows.UI.Xaml.Controls.SearchBox.' »

Cet objet est disponible pour les applications qui participent au contrat de recherche. Pour fournir aux utilisateurs des résultats de 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 d’activation de recherche , consultez webUISearchActivatedEventArgs (JavaScript) ou SearchActivatedEventArgs (C#/C++/VB).

Vous pouvez voir 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 (Windows 8).

Propriétés

Language	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.
PlaceholderText	Texte d’espace réservé dans la zone de recherche lorsque l’utilisateur n’a pas entré de caractères.
QueryText	Texte actuel dans la zone de recherche du volet de recherche.
SearchHistoryContext	Chaîne qui identifie le contexte de la recherche et est utilisée pour stocker l’historique de recherche de l’utilisateur dans l’application.
SearchHistoryEnabled	Indique si les recherches précédentes de l’utilisateur dans l’application sont automatiquement suivies et utilisées pour fournir des suggestions.
ShowOnKeyboardInput	Obtient ou définit si l’utilisateur peut ouvrir le volet de recherche en tapant.
Visible	Indique si le volet de recherche est ouvert.

Méthodes

GetForCurrentView()	Récupère une instance du volet de recherche à partir de laquelle les utilisateurs peuvent effectuer des recherches dans l’application.
HideThisApplication()	Masque l’interface utilisateur de l’application actuelle.
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	Spécifie si les suggestions basées sur des fichiers locaux sont automatiquement affichées dans le volet de recherche et définit les critères que Windows utilise pour localiser et filtrer ces suggestions.
Show()	Affiche le volet de recherche.
Show(String)	Affiche le volet de recherche avec la chaîne de requête initiale spécifiée.
TrySetQueryText(String)	Tente de définir le texte dans la zone de recherche du volet de recherche.

Événements

QueryChanged	Se déclenche lorsque l’utilisateur modifie le texte dans la zone de recherche.
QuerySubmitted	Se déclenche lorsque l’utilisateur envoie le texte dans la zone de recherche et que l’application doit afficher les résultats de la recherche.
ResultSuggestionChosen	Se déclenche lorsque l’utilisateur sélectionne l’un des résultats suggérés fournis par l’application et affichés dans le volet de recherche.
SuggestionsRequested	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.
VisibilityChanged	Se déclenche lorsque l’utilisateur ouvre ou ferme le volet de recherche.

Voir aussi

• GetForCurrentView()
• ActivationKind
• SearchActivatedEventArgs
• Activated
• Exemple de contrat de recherche (Windows 8)
• Gérer l’activation d’une application