SearchPane Clase

Definición

Espacio de nombres:

Windows.ApplicationModel.Search

En desuso. En su lugar, use el control Windows.UI.Xaml.Controls.AutoSuggestBox . Representa y administra el panel de búsqueda que se abre cuando un usuario activa el acceso de búsqueda.

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

Herencia

Object Platform::Object IInspectable SearchPane

Atributos

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Requisitos de Windows

Familia de dispositivos	Windows Desktop Extension SDK (se introdujo en la versión 10.0.10240.0) Xbox One Extensions for the UWP (se introdujo en la versión 10.0.10586.0)
API contract	Windows.ApplicationModel.Search.SearchContract (se introdujo en la versión v1.0)

Comentarios

Importante

Para implementar la búsqueda en una aplicación para Windows 10 o posterior, use AutoSuggestBox. Consulta Cuadro de sugerencias automáticas para obtener más información.

No debe usar las API Windows.ApplicationModel.Search (SearchPane, SearchContract) ni las API searchBox en aplicaciones para Windows 10 o posterior.

Nota:

Una aplicación no puede usar el cuadro de búsqueda (Windows.UI.Xaml.Controls.SearchBox/WinJS.UI.SearchBox) y searchPane. El uso del cuadro de búsqueda y el panel de búsqueda de la misma aplicación hace que la aplicación produzca una excepción con este mensaje: "No se puede crear una instancia de tipo 'Windows.UI.Xaml.Controls.SearchBox'".

Este objeto está disponible para las aplicaciones que participan en el contrato de búsqueda. Para proporcionar a los usuarios resultados de búsqueda, debes agregar código al controlador de eventos Activado que responda cuando la aplicación se active para la búsqueda. Para obtener más información sobre cómo responder a eventos de activación de búsqueda , consulte webUISearchActivatedEventArgs (JavaScript) o SearchActivatedEventArgs (C#/C++/VB).

Puede ver ejemplos de código que muestran cómo responder a eventos de búsqueda y administrar el panel de búsqueda en el ejemplo de contrato de búsqueda (Windows 8).

Propiedades

Language	Etiqueta de idioma del Grupo de tareas de ingeniería de Internet (IETF) (estándar BCP 47) que identifica el idioma asociado actualmente al dispositivo de entrada de texto del usuario.
PlaceholderText	Texto del marcador de posición en el cuadro de búsqueda cuando el usuario no ha escrito ningún carácter.
QueryText	Texto actual en el cuadro de búsqueda del panel de búsqueda.
SearchHistoryContext	Cadena que identifica el contexto de la búsqueda y se usa para almacenar el historial de búsqueda del usuario con la aplicación.
SearchHistoryEnabled	Indica si se realiza un seguimiento automático de las búsquedas anteriores del usuario con la aplicación y se usa para proporcionar sugerencias.
ShowOnKeyboardInput	Obtiene o establece si el usuario puede abrir el panel de búsqueda escribiendo.
Visible	Indica si el panel de búsqueda está abierto.

Métodos

GetForCurrentView()	Recupera una instancia del panel de búsqueda desde la que los usuarios pueden buscar en la aplicación.
HideThisApplication()	Oculta la interfaz de usuario de la aplicación actual.
SetLocalContentSuggestionSettings(LocalContentSuggestionSettings)	Especifica si las sugerencias basadas en archivos locales se muestran automáticamente en el panel de búsqueda y define los criterios que Windows usa para buscar y filtrar estas sugerencias.
Show()	Muestra el panel de búsqueda.
Show(String)	Muestra el panel de búsqueda con la cadena de consulta inicial especificada.
TrySetQueryText(String)	Intenta establecer el texto en el cuadro de búsqueda del panel de búsqueda.

Eventos

QueryChanged	Se activa cuando el usuario cambia el texto en el cuadro de búsqueda.
QuerySubmitted	Se activa cuando el usuario envía el texto en el cuadro de búsqueda y la aplicación debe mostrar los resultados de búsqueda.
ResultSuggestionChosen	Se activa cuando el usuario selecciona uno de los resultados sugeridos proporcionados por la aplicación y se muestra en el panel de búsqueda.
SuggestionsRequested	Se produce cuando cambia el texto de la consulta del usuario y la aplicación debe proporcionar nuevas sugerencias para mostrarse en el panel de búsqueda.
VisibilityChanged	Se activa cuando el usuario abre o cierra el panel de búsqueda.

Consulte también

• GetForCurrentView()
• ActivationKind
• SearchActivatedEventArgs
• Activated
• Ejemplo de contrato de búsqueda (Windows 8)
• Controlar la activación de aplicaciones