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. Дополнительные сведения см. в разделе Поле автозаполнения .

Не следует использовать API Windows.ApplicationModel.Search (SearchPane, SearchContract) или API SearchBox в приложениях для Windows 10 или более поздних версий.

Примечание

Приложение не может использовать одновременно поле поиска (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) и SearchPane. Использование поля поиска и области поиска в одном приложении приводит к тому, что приложение выдает исключение с сообщением "Не удается создать экземпляр типа Windows.UI.Xaml.Controls.SearchBox".

Этот объект доступен для приложений, участвующих в контракте поиска. Чтобы предоставить пользователям результаты поиска, необходимо добавить код в обработчик событий Activated, который реагирует на активацию приложения для поиска. Дополнительные сведения о реагировании на события активации поиска см. в разделах webUISearchActivatedEventArgs (JavaScript) или SearchActivatedEventArgs (C#/C++/VB).

Примеры кода, демонстрирующие реагирование на события поиска и управление панелью поиска, приведены в примере контракта поиска (Windows 8).

Свойства

Language	Тег языка Internet Engineering Task Force (IETF) (стандарт BCP 47), который определяет язык, связанный в настоящее время с устройством ввода текста пользователя.
PlaceholderText	Замещающий текст в поле поиска, если пользователь не ввел никаких символов.
QueryText	Текущий текст в поле поиска области поиска.
SearchHistoryContext	Строка, определяющая контекст поиска и используемая для хранения журнала поиска пользователя в приложении.
SearchHistoryEnabled	Указывает, отслеживаются ли предыдущие поисковые запросы пользователя в приложении и используются ли они для предоставления предложений.
ShowOnKeyboardInput	Возвращает или задает значение, указывающее, может ли пользователь открыть область поиска, введя .
Visible	Указывает, открыта ли область поиска.

Методы

GetForCurrentView()	Извлекает экземпляр области поиска, из которой пользователи могут выполнять поиск в приложении.
HideThisApplication()	Скрывает пользовательский интерфейс текущего приложения.
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	Указывает, будут ли предложения, основанные на локальных файлах, автоматически отображаться в области поиска, и определяет критерии, которые Windows использует для поиска и фильтрации этих предложений.
Show()	Отображает область поиска.
Show(String)	Отображает область поиска с указанной начальной строкой запроса.
TrySetQueryText(String)	Пытается задать текст в поле поиска области поиска.

События

QueryChanged	Возникает, когда пользователь изменяет текст в поле поиска.
QuerySubmitted	Возникает, когда пользователь отправляет текст в поле поиска и приложение должно отображать результаты поиска.
ResultSuggestionChosen	Возникает, когда пользователь выбирает один из предложенных результатов, предоставленных приложением и отображаемых в области поиска.
SuggestionsRequested	Происходит при изменении текста запроса пользователя и необходимости предоставления приложению новых предложений для отображения в области поиска.
VisibilityChanged	Срабатывает, когда пользователь открывает или закрывает область поиска.

См. также раздел

• GetForCurrentView()
• ActivationKind
• SearchActivatedEventArgs
• Activated
• Пример контракта поиска (Windows 8)
• Обработка активации приложения