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 を使用しないでください。

Note

アプリでは、検索ボックス (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) と SearchPane の両方を使用することはできません。 同じアプリで検索ボックスと検索ウィンドウの両方を使用すると、"型 'Windows.UI.Xaml.Controls.SearchBox.' のインスタンスを作成できません"というメッセージでアプリが例外をスローします。

アプリ内検索ボックスがある場合は、このメソッドを使用して、検索ウィンドウと検索ボックスの間の一貫性を維持します。 ほとんどのアプリは、アプリ内検索 UI を使用する代わりに、検索ウィンドウで返信する必要があります。