SearchPane.SuggestionsRequested Evento

Definição

Namespace:

Windows.ApplicationModel.Search

Ocorre quando o texto da consulta do usuário é alterado e o aplicativo precisa fornecer novas sugestões para exibição no painel de pesquisa.

/// [add: 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")]
/// [remove: 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")]
// Register
event_token SuggestionsRequested(TypedEventHandler<SearchPane, SearchPaneSuggestionsRequestedEventArgs const&> const& handler) const;

// Revoke with event_token
void SuggestionsRequested(event_token const* cookie) const;

// Revoke with event_revoker
SearchPane::SuggestionsRequested_revoker SuggestionsRequested(auto_revoke_t, TypedEventHandler<SearchPane, SearchPaneSuggestionsRequestedEventArgs const&> const& handler) const;

[add: 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")]
[remove: 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 event TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs> SuggestionsRequested;

function onSuggestionsRequested(eventArgs) { /* Your code */ }
searchPane.addEventListener("suggestionsrequested", onSuggestionsRequested);
searchPane.removeEventListener("suggestionsrequested", onSuggestionsRequested);
- or -
searchPane.onsuggestionsrequested = onSuggestionsRequested;

Public Custom Event SuggestionsRequested As TypedEventHandler(Of SearchPane, SearchPaneSuggestionsRequestedEventArgs) 

Tipo de evento

TypedEventHandler<SearchPane,SearchPaneSuggestionsRequestedEventArgs>

Atributos

DeprecatedAttribute

Comentários

Importante

Para implementar a pesquisa em um aplicativo para Windows 10 ou posterior, use AutoSuggestBox. Confira 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 posterior.

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.'"

As sugestões podem vir de três fontes: histórico de pesquisa, arquivos locais ou de uma fonte especificada pelo aplicativo. As sugestões são agrupadas por sua origem e exibidas na seguinte ordem no painel de pesquisa: histórico de pesquisa, arquivos locais e fontes especificadas pelo aplicativo.

Se seu aplicativo participar do contrato de Pesquisa e você quiser que seu aplicativo exiba sugestões de fontes que você especificar, registre um manipulador para responder quando esse evento for acionado. No manipulador de eventos SuggestionsRequested, responda obtendo sugestões e preenchendo SearchSuggestionCollection com base em SearchPaneSuggestionsRequestedEventArgs do usuário. QueryText.

Observação

Se você quiser responder a esse evento de forma assíncrona, deverá usar SearchPaneSuggestionsRequestedEventArgs. Solicitação. GetDeferral.

Não é possível fornecer sugestões para uma caixa de pesquisa vazia, portanto, esse evento não é acionado quando o usuário atualiza a caixa de pesquisa para ficar vazia.

Tipos de sugestões de pesquisa

Há dois tipos de sugestões que seu aplicativo pode exibir: sugestões que ajudam os usuários a refinar uma consulta (sugestões de consulta) e sugestões que são resultados reais de uma consulta (sugestões de resultados). Você pode optar por exibir um ou ambos os tipos de sugestões.

Se você fornecer sugestões de consulta e o usuário selecionar uma, seu aplicativo deverá responder exibindo os resultados da consulta selecionada e refinada na página de resultados da pesquisa do aplicativo.

Se você fornecer sugestões de resultados, também deverá registrar um manipulador de eventos ResultSuggestionChosen para que possa responder quando o usuário selecionar uma de suas sugestões de resultado e você poderá exibir o resultado para o usuário.

Obtendo sugestões

Aqui estão alguns exemplos de fontes que seu aplicativo pode usar para obter sugestões:

• De uma lista local, estática e definida pelo aplicativo
• De uma URL que dá suporte a sugestões no formato OpenSearch

Exibindo sugestões fornecidas pelo aplicativo no painel de pesquisa

Depois de obter sugestões, você as exibe no painel de pesquisa adicionando-as à Solicitação. SearchSuggestionCollection.

No máximo, o painel de pesquisa pode exibir 5 sugestões. Se você optar por exibir sugestões de consulta e sugestões de resultados, deverá agrupar as sugestões por tipo de sugestão (consulta ou resultado) e separar os grupos usando AppendSearchSeparator. Cada separador assume o lugar de uma sugestão e deve ser seguido por pelo menos uma sugestão, diminuindo o número de sugestões que você pode exibir.

Confira também

• SearchPane
• ResultSuggestionChosen
• SearchSuggestionCollection
• SearchPaneSuggestionsRequestedEventArgs
• SearchSuggestionCollection
• Amostra de contrato de pesquisa (Windows 8)