SearchPane.TrySetQueryText | trySetQueryText method (Windows)

SearchPane.TrySetQueryText | trySetQueryText method

This topic has not yet been rated - Rate this topic

Attempts to set the text in the search box of the search pane.

Syntax

Public Function TrySetQueryText(
  query As String 
) As Boolean

Parameters

query

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The query text to show in the search pane's search box.

Return value

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

True if the search box text was set successfully. Otherwise, false.

Remarks

If you have an in-app search box, use this method to maintain consistency between the search pane and your search box. Most apps should reply on the search pane instead of using in-app search UI. To learn more, see Guidelines and checklist for search.

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Windows.ApplicationModel.Search Windows::ApplicationModel::Search [C++]
Metadata	Windows.winmd