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。 有关详细信息 ，请参阅自动建议框 。

不应在 Windows 10 或更高版本的应用中使用 Windows.ApplicationModel.Search API (SearchPane、 SearchContract) 或 SearchBox API。

注意

应用不能同时使用搜索框 (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) 和 SearchPane。 在同一应用中同时使用搜索框和搜索窗格会导致应用引发异常，并显示以下消息：“无法创建'Windows.UI.Xaml.Controls.SearchBox'类型的实例。”

此对象可用于参与搜索合约的应用。 为了向用户提供搜索结果，必须将代码添加到激活的事件处理程序中，以便在激活应用进行搜索时响应。 若要了解有关响应 搜索 激活事件的详细信息，请参阅 webUISearchActivatedEventArgs (JavaScript) 或 SearchActivatedEventArgs (C#/C++/VB) 。

可以查看演示如何响应搜索事件和管理搜索窗格的代码示例，这些示例位于 (Windows 8) 的搜索协定示例中。

属性

Language	Internet 工程任务组 (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)
• 处理应用激活