SearchPane 類別

定義

命名空間:

Windows.ApplicationModel.Search

已取代。 請改用 Windows.UI.Xaml.Controls.AutoSuggestBox 控制項。 代表及管理當使用者啟動搜尋常用鍵時開啟的搜尋窗格。

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

繼承

Object Platform::Object IInspectable SearchPane

屬性

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Windows 需求

裝置系列	Windows Desktop Extension SDK (已於 10.0.10240.0 引進) Xbox One Extensions for the UWP (已於 10.0.10586.0 引進)
API contract	Windows.ApplicationModel.Search.SearchContract (已於 v1.0 引進)

備註

重要

若要在應用程式中實作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'的實例。」

此物件可供參與搜尋合約的應用程式使用。 若要為使用者提供搜尋結果，您必須將程式碼新增至您的 Activated 事件處理常式，以在應用程式啟用搜尋時回應。 若要深入瞭解如何回應 搜尋 啟用事件，請參閱 webUISearchActivatedEventArgs (JavaScript) 或 SearchActivatedEventArgs (C#/C++/VB) 。

您可以看到程式碼範例，示範如何回應搜尋事件及管理搜尋合約範例中的搜尋窗格， (Windows 8) 。

屬性

Language	網際網路工程工作組 (IETF) 語言標籤 (BCP 47 標準) ，可識別目前與使用者文字輸入裝置相關聯的語言。
PlaceholderText	當使用者未輸入任何字元時，搜尋方塊中的預留位置文字。
QueryText	搜尋窗格搜尋方塊中的目前文字。
SearchHistoryContext	識別搜尋內容的字串，用來儲存使用者的搜尋歷程記錄與應用程式。
SearchHistoryEnabled	指出使用者先前使用應用程式的搜尋是否會自動追蹤，並用來提供建議。
ShowOnKeyboardInput	取得或設定使用者是否可以輸入來開啟搜尋窗格。
Visible	指出是否開啟搜尋窗格。

方法

GetForCurrentView()	擷取搜尋窗格的實例，使用者可以在其中搜尋應用程式內。
HideThisApplication()	隱藏目前應用程式的 UI。
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	指定根據本機檔案的建議是否會自動顯示在搜尋窗格中，並定義 Windows 用來尋找和篩選這些建議的準則。
Show()	顯示搜尋窗格。
Show(String)	顯示具有指定之初始查詢字串的搜尋窗格。
TrySetQueryText(String)	嘗試在搜尋窗格的搜尋方塊中設定文字。

事件

QueryChanged	當使用者變更搜尋方塊中的文字時引發。
QuerySubmitted	當使用者在搜尋方塊中提交文字，且應用程式需要顯示搜尋結果時引發。
ResultSuggestionChosen	當使用者選取應用程式所提供的其中一個建議結果，並在搜尋窗格中顯示時引發。
SuggestionsRequested	發生于使用者的查詢文字變更，且應用程式需要提供新的建議，才能顯示在搜尋窗格中。
VisibilityChanged	當使用者開啟或關閉搜尋窗格時引發。

另請參閱

• GetForCurrentView()
• ActivationKind
• SearchActivatedEventArgs
• Activated
• 搜尋合約範例 (Windows 8)
• 處理應用程式啟用