SearchPane Klasse

Definition

Namespace:

Windows.ApplicationModel.Search

Veraltet. Verwenden Sie stattdessen das Steuerelement Windows.UI.Xaml.Controls.AutoSuggestBox . Stellt den Suchbereich dar und verwaltet diesen, der geöffnet wird, wenn ein Benutzer den Charm Suchen aktiviert.

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

Vererbung

Object Platform::Object IInspectable SearchPane

Attribute

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Windows-Anforderungen

Gerätefamilie	Windows Desktop Extension SDK (eingeführt in 10.0.10240.0) Xbox One Extensions for the UWP (eingeführt in 10.0.10586.0)
API contract	Windows.ApplicationModel.Search.SearchContract (eingeführt in v1.0)

Hinweise

Wichtig

Verwenden Sie AutoSuggestBox, um die Suche in einer App für Windows 10 oder höher zu implementieren. Weitere Informationen finden Sie im Feld für automatische Vorschläge .

Sie sollten keine Windows.ApplicationModel.Search-APIs (SearchPane, SearchContract) oder SearchBox-APIs in Apps für Windows 10 oder höher verwenden.

Hinweis

Eine App kann nicht sowohl das Suchfeld (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) als auch die SearchPane verwenden. Wenn Sie sowohl das Suchfeld als auch den Suchbereich in derselben App verwenden, löst die App eine Ausnahme mit der folgenden Meldung aus: "Instanz vom Typ 'Windows.UI.Xaml.Controls.SearchBox' kann nicht erstellt werden."

Dieses Objekt ist für Apps verfügbar, die am Suchvertrag teilnehmen. Um Benutzern Suchergebnisse bereitzustellen, müssen Sie Ihrem Activated-Ereignishandler Code hinzufügen, der antwortet, wenn Ihre App für die Suche aktiviert wird. Weitere Informationen zum Reagieren auf Suchaktivierungsereignisse finden Sie unter webUISearchActivatedEventArgs (JavaScript) oder SearchActivatedEventArgs (C#/C++/VB).

Codebeispiele, die veranschaulichen, wie Sie auf Suchereignisse reagieren und den Suchbereich verwalten, finden Sie im Suchvertragsbeispiel (Windows 8).

Eigenschaften

Language	Das IETF-Sprachtag (Internet Engineering Task Force) (BCP 47-Standard), das die Sprache identifiziert, die dem Texteingabegerät des Benutzers derzeit zugeordnet ist.
PlaceholderText	Der Platzhaltertext im Suchfeld, wenn der Benutzer keine Zeichen eingegeben hat.
QueryText	Der aktuelle Text im Suchfeld des Suchbereichs.
SearchHistoryContext	Eine Zeichenfolge, die den Kontext der Suche identifiziert und zum Speichern des Suchverlaufs des Benutzers in der App verwendet wird.
SearchHistoryEnabled	Gibt an, ob die vorherigen Suchvorgänge des Benutzers mit der App automatisch nachverfolgt und zum Bereitstellen von Vorschlägen verwendet werden.
ShowOnKeyboardInput	Ruft ab oder legt fest, ob der Benutzer den Suchbereich durch Eingabe öffnen kann.
Visible	Gibt an, ob der Suchbereich geöffnet ist.

Methoden

GetForCurrentView()	Ruft eine Instanz des Suchbereichs ab, aus dem Benutzer innerhalb der App suchen können.
HideThisApplication()	Blendet die Benutzeroberfläche der aktuellen App aus.
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	Gibt an, ob Vorschläge, die auf lokalen Dateien basieren, automatisch im Suchbereich angezeigt werden, und definiert die Kriterien, die Windows zum Suchen und Filtern dieser Vorschläge verwendet.
Show()	Zeigt den Suchbereich an.
Show(String)	Zeigt den Suchbereich mit der angegebenen anfänglichen Abfragezeichenfolge an.
TrySetQueryText(String)	Versucht, den Text im Suchfeld des Suchbereichs festzulegen.

Ereignisse

QueryChanged	Wird ausgelöst, wenn der Benutzer den Text im Suchfeld ändert.
QuerySubmitted	Wird ausgelöst, wenn der Benutzer den Text im Suchfeld übermittelt und die App Suchergebnisse anzeigen muss.
ResultSuggestionChosen	Wird ausgelöst, wenn der Benutzer eines der vorgeschlagenen Ergebnisse auswählt, die von der App bereitgestellt und im Suchbereich angezeigt werden.
SuggestionsRequested	Tritt auf, wenn sich der Abfragetext des Benutzers ändert und die App neue Vorschläge bereitstellen muss, die im Suchbereich angezeigt werden sollen.
VisibilityChanged	Wird ausgelöst, wenn der Benutzer den Suchbereich öffnet oder schließt.

Weitere Informationen

• GetForCurrentView()
• ActivationKind
• SearchActivatedEventArgs
• Activated
• Beispiel für einen Suchvertrag (Windows 8)
• Behandeln der App-Aktivierung