SearchPane.TrySetQueryText(String) 方法

定义

命名空间:

Windows.ApplicationModel.Search

尝试在搜索窗格的搜索框中设置文本。

public:
 virtual bool TrySetQueryText(Platform::String ^ query) = TrySetQueryText;

/// [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")]
bool TrySetQueryText(winrt::hstring const& query);

[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 bool TrySetQueryText(string query);

function trySetQueryText(query)

Public Function TrySetQueryText (query As String) As Boolean

参数

query

String

Platform::String

winrt::hstring

要显示在搜索窗格搜索框中的查询文本。

返回

Boolean

bool

true 如果成功设置搜索框文本，则为 ;否则为 false。

属性

DeprecatedAttribute

注解

重要

若要在应用中实现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'类型的实例。”

如果你有应用内搜索框，请使用此方法保持搜索窗格和搜索框之间的一致性。 大多数应用应在搜索窗格上答复，而不是使用应用内搜索 UI。