SearchPane.SuggestionsRequested 事件

定義

命名空間:

Windows.ApplicationModel.Search

發生于使用者的查詢文字變更，且應用程式需要提供新的建議，才能顯示在搜尋窗格中時。

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

事件類型

TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs>

屬性

DeprecatedAttribute

備註

重要

若要在應用程式中實作Windows 10或更新版本的搜尋，請使用AutoSuggestBox。 如需詳細資訊 ，請參閱自動建議方塊 。

您不應該在 app 中使用Windows.ApplicationModel.Search API (SearchPane、 SearchContract) 或SearchBox API，以供Windows 10或更新版本使用。

注意

應用程式無法使用搜尋方塊 (Windows.UI.Xaml.Controls.SearchBoxWinJS.UI.SearchBox/) 和 SearchPane。 在相同的應用程式中同時使用搜尋方塊和搜尋窗格，會導致應用程式擲回例外狀況，並顯示下列訊息：「無法建立類型為 'Windows.UI.Xaml.Controls.SearchBox' 的實例」。

建議可能來自三個來源：搜尋歷程記錄、本機檔案，或來自應用程式指定的來源。 建議會依來源分組，並在搜尋窗格中依下列順序顯示：搜尋歷程記錄、本機檔案，以及應用程式指定的來源。

如果您的 app 參與搜尋合約，而且您希望您的應用程式顯示您指定來源的建議，則必須註冊處理常式，以在引發此事件時回應。 在您的 SuggestionsRequested 事件處理常式中，根據使用者的SearchPaneSuggestionsRequestedEventArgs取得建議並填入SearchSuggestionCollection來回應。QueryText。

注意

如果您想要以非同步方式回應此事件，您必須使用 SearchPaneSuggestionsRequestedEventArgs。要求。GetDeferral。

無法提供空白搜尋方塊的建議，因此當使用者將搜尋方塊更新為空白時，不會引發此事件。

搜尋建議的類型

您的應用程式可以顯示兩種類型的建議：可協助使用者精簡查詢的建議 (查詢建議) ，以及查詢實際結果的建議 (結果建議) 。 您可以選擇顯示或兩種類型的建議。

如果您提供查詢建議，且使用者選取一個查詢，則您的應用程式應該會在應用程式的搜尋結果頁面中顯示所選取、精簡查詢的結果來回應。

如果您提供結果建議，您也必須註冊 ResultSuggestionChosen 事件處理常式，以便在使用者選取其中一個結果建議時回應，而且您可以將結果顯示給使用者。

取得建議

以下是您的應用程式可用來取得建議的幾個來源範例：

• 從應用程式定義、靜態、本機清單
• 從支援OpenSearch 格式建議的 URL

在搜尋窗格中顯示應用程式提供的建議

取得建議之後，您會將其新增至 [要求]，以在搜尋窗格中顯示建議。SearchSuggestionCollection。

搜尋窗格最多可以顯示 5 個建議。 如果您選擇同時顯示查詢建議和結果建議，您應該依建議類型將建議分組 (查詢或結果) ，並使用 AppendSearchSeparator分隔群組。 每個分隔符號都會取代建議，且後面至少必須接著一個建議，減少您可以顯示的建議數目。

另請參閱

• SearchPane
• ResultSuggestionChosen
• SearchSuggestionCollection
• SearchPaneSuggestionsRequestedEventArgs
• SearchSuggestionCollection
• 搜尋合約範例 (Windows 8)