SearchPane Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Preterido. Use o controle Windows.UI.Xaml.Controls.AutoSuggestBox . Representa e gerencia o painel de pesquisa que é aberto quando um usuário ativa o botão Pesquisar.
public ref class SearchPane sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Search.SearchContract, 65536)]
/// [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)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class SearchPane final/// [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.Deprecated("SearchPane may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.ApplicationModel.Search.SearchContract))]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class SearchPane[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 SearchPanePublic NotInheritable Class SearchPane- Herança
- Atributos
Requisitos do Windows
| Família de dispositivos |
Windows Desktop Extension SDK (introduzida na 10.0.10240.0)
Xbox One Extensions for the UWP (introduzida na 10.0.10586.0) |
| API contract |
Windows.ApplicationModel.Search.SearchContract (introduzida na v1.0)
|
Comentários
Importante
Para implementar a pesquisa em um aplicativo para Windows 10 ou posterior, use AutoSuggestBox. Consulte Caixa de sugestão automática para obter mais informações.
Você não deve usar APIs Windows.ApplicationModel.Search (SearchPane, SearchContract) ou APIs SearchBox em aplicativos para Windows 10 ou posteriores.
Observação
Um aplicativo não pode usar a caixa de pesquisa (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) e o SearchPane. Usar a caixa de pesquisa e o painel de pesquisa no mesmo aplicativo faz com que o aplicativo gere uma exceção com esta mensagem: "Não é possível criar uma instância do tipo 'Windows.UI.Xaml.Controls.SearchBox.'"
Esse objeto está disponível para aplicativos que participam do contrato de pesquisa. Para fornecer aos usuários os resultados da pesquisa, você deve adicionar código ao manipulador de eventos ativado que responde quando seu aplicativo é ativado para pesquisa. Para saber mais sobre como responder a eventos de ativação de pesquisa, consulte webUISearchActivatedEventArgs (JavaScript) ou SearchActivatedEventArgs (C#/C++/VB).
Você pode ver exemplos de código que demonstram como responder a eventos de pesquisa e gerenciar o painel de pesquisa no exemplo de contrato de pesquisa (Windows 8).
Propriedades
| Language |
A marca de linguagem IETF (Internet Engineering Task Force) (padrão BCP 47) que identifica o idioma atualmente associado ao dispositivo de entrada de texto do usuário. |
| PlaceholderText |
O texto do espaço reservado na caixa de pesquisa quando o usuário não inseriu nenhum caractere. |
| QueryText |
O texto atual na caixa de pesquisa do painel de pesquisa. |
| SearchHistoryContext |
Uma cadeia de caracteres que identifica o contexto da pesquisa e é usada para armazenar o histórico de pesquisa do usuário com o aplicativo. |
| SearchHistoryEnabled |
Indica se as pesquisas anteriores do usuário com o aplicativo são rastreadas automaticamente e usadas para fornecer sugestões. |
| ShowOnKeyboardInput |
Obtém ou define se o usuário pode abrir o painel de pesquisa digitando. |
| Visible |
Indica se o painel de pesquisa está aberto. |
Métodos
| GetForCurrentView() |
Recupera uma instância do painel de pesquisa da qual os usuários podem pesquisar dentro do aplicativo. |
| HideThisApplication() |
Oculta a interface do usuário do aplicativo atual. |
| SetLocalContentSuggestionSettings(LocalContentSuggestionSettings) |
Especifica se as sugestões baseadas em arquivos locais são exibidas automaticamente no painel de pesquisa e define os critérios que o Windows usa para localizar e filtrar essas sugestões. |
| Show() |
Mostra o painel de pesquisa. |
| Show(String) |
Mostra o painel de pesquisa com a cadeia de caracteres de consulta inicial especificada. |
| TrySetQueryText(String) |
Tenta definir o texto na caixa de pesquisa do painel de pesquisa. |
Eventos
| QueryChanged |
Aciona quando o usuário altera o texto na caixa de pesquisa. |
| QuerySubmitted |
Aciona quando o usuário envia o texto na caixa de pesquisa e o aplicativo precisa exibir os resultados da pesquisa. |
| ResultSuggestionChosen |
Aciona quando o usuário seleciona um dos resultados sugeridos fornecidos pelo aplicativo e exibidos no painel de pesquisa. |
| SuggestionsRequested |
Ocorre quando o texto da consulta do usuário é alterado e o aplicativo precisa fornecer novas sugestões para exibir no painel de pesquisa. |
| VisibilityChanged |
Aciona quando o usuário abre ou fecha o painel de pesquisa. |