SearchPane.SuggestionsRequested Ereignis

Definition

Namespace:

Windows.ApplicationModel.Search

Tritt auf, wenn sich der Abfragetext des Benutzers ändert und die App neue Vorschläge bereitstellen muss, die im Suchbereich angezeigt werden sollen.

/// [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) 

Ereignistyp

TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs>

Attribute

DeprecatedAttribute

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: "Instance vom Typ 'Windows.UI.Xaml.Controls.SearchBox' kann nicht erstellt werden."

Vorschläge können aus drei Quellen stammen: Suchverlauf, lokale Dateien oder aus einer von der App angegebenen Quelle. Vorschläge werden nach ihrer Quelle gruppiert und in der folgenden Reihenfolge im Suchbereich angezeigt: Suchverlauf, lokale Dateien und dann von der App angegebene Quellen.

Wenn Ihre App am Suchvertrag teilnimmt und Sie möchten, dass Ihre App Vorschläge aus von Ihnen angegebenen Quellen anzeigt, müssen Sie einen Handler registrieren, der beim Auslösen dieses Ereignisses reagiert. Antworten Sie in Ihrem SuggestionsRequested-Ereignishandler, indem Sie Vorschläge abrufen und die SearchSuggestionCollection basierend auf den SearchPaneSuggestionsRequestedEventArgs des Benutzers auffüllen. QueryText.

Hinweis

Wenn Sie asynchron auf dieses Ereignis reagieren möchten, müssen Sie SearchPaneSuggestionsRequestedEventArgs verwenden. Anforderung. GetDeferral.

Es können keine Vorschläge für ein leeres Suchfeld bereitgestellt werden, sodass dieses Ereignis nicht ausgelöst wird, wenn der Benutzer das Suchfeld als leer aktualisiert.

Arten von Suchvorschlägen

Es gibt zwei Arten von Vorschlägen, die Ihre App anzeigen kann: Vorschläge, die Benutzern helfen, eine Abfrage (Abfragevorschläge) zu verfeinern, und Vorschläge, die tatsächliche Ergebnisse einer Abfrage sind (Ergebnisvorschläge). Sie können entweder oder beide Arten von Vorschlägen anzeigen.

Wenn Sie Abfragevorschläge bereitstellen und der Benutzer einen auswählt, sollte Ihre App antworten, indem sie Ergebnisse für die ausgewählte, verfeinerte Abfrage auf der Suchergebnisseite Ihrer App anzeigt.

Wenn Sie Ergebnisvorschläge bereitstellen, müssen Sie auch einen ResultSuggestionChosen-Ereignishandler registrieren, damit Sie antworten können, wenn der Benutzer einen Ihrer Ergebnisvorschläge auswählt, und Sie das Ergebnis dem Benutzer anzeigen können.

Abrufen von Vorschlägen

Hier sind einige Beispiele für Quellen, die Ihre App verwenden kann, um Vorschläge zu erhalten:

• Aus einer von der App definierten, statischen, lokalen Liste
• Von einer URL, die Vorschläge im OpenSearch-Format unterstützt

Anzeigen von app-bereitgestellten Vorschlägen im Suchbereich

Nachdem Sie Vorschläge erhalten haben, zeigen Sie sie im Suchbereich an, indem Sie sie der Anforderung hinzufügen. SearchSuggestionCollection.

Der Suchbereich kann höchstens 5 Vorschläge anzeigen. Wenn Sie sowohl Abfragevorschläge als auch Ergebnisvorschläge anzeigen möchten, sollten Sie die Vorschläge nach Vorschlagstyp (Abfrage oder Ergebnis) gruppieren und die Gruppen mithilfe von AppendSearchSeparator trennen. Jedes Trennzeichen tritt an die Stelle eines Vorschlags und muss von mindestens einem Vorschlag gefolgt werden, wodurch die Anzahl der Vorschläge verringert wird, die Sie anzeigen können.

Weitere Informationen

• SearchPane
• ResultSuggestionChosen
• SearchSuggestionCollection
• SearchPaneSuggestionsRequestedEventArgs
• SearchSuggestionCollection
• Beispiel für einen Suchvertrag (Windows 8)