Búsqueda

Búsqueda de texto nativa en la composición del Viewer

El Doconut Viewer ofrece una búsqueda normal utilizando texto extraído por el visor de formato o una redirección de PDF basada en texto. Requiere la capacidad de licencia Search.

Habilitar la interfaz de búsqueda

Search es un módulo del Viewer, no una barra de herramientas independiente. La página completa debe incluir los recursos del Viewer, la barra de herramientas del Viewer, el montaje del Viewer y el objViewer inicializado; luego el Ribbon de Search se monta y se adjunta a esa misma instancia.

Search y la anotación son funciones con licencia incorporadas, no paquetes AddPlugin<T>(). Solicite los recursos de búsqueda del Viewer inyectado; sus etiquetas se emiten solo cuando la licencia concede Search.

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss = true,
    IncludeSearchCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery = true,
    IncludeViewerScripts = true,
    IncludeSearchScripts = true,
    IncludeSearchBar = true
}))

El ribbon incrustado llama a los mismos métodos JavaScript disponibles para una UI personalizada.

Mantenga la composición completa del Viewer visible en el marcado, inicialice docViewer primero y luego adjunte el Ribbon con licencia:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Controles del visor, incluido el botón que abre Search -->
</nav>
<div id="searchBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
    let searchBar = null;
    let currentToken = '';

    const objViewer = $('#div_ctlDoc').docViewer({
        BasePath: 'doconut',
        ResPath: 'doconut-res/images'
    });

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token: currentToken }),
        onStatus: (message) => console.log(message),
        onToast: (message, type) => console.log(type, message),
        onLayout: () => requestAnimationFrame(() => objViewer.Refit())
    });
    searchBar.attach(objViewer);
        </text>
    }
</script>

El if del lado del servidor es importante: sin la capacidad de Search, ReferenceScripts omite el script del Ribbon, por lo que una llamada no protegida a doconutSearchBar(...) lanzaría una excepción y detendría el inicio de la página del viewer.

El componente inyecta los grupos Find, Options y Results y maneja la búsqueda, la limpieza, el recuento de coincidencias y la navegación a coincidencias anteriores/siguientes. Una barra de herramientas del Viewer propiedad del host solo necesita activarla:

javascript
searchBar.isOpen() ? searchBar.close() : searchBar.open();

Su API pública es intencionalmente pequeña:

MethodPurpose
attach(objViewer)Conecta el Ribbon al viewer inicializado; se requiere una vez
open() / close()Muestra u oculta el Ribbon; cerrar también elimina los resaltados
reset()Borra el término actual, el recuento de resultados y los resaltados
isOpen()Informa si el Ribbon está visible
setStatus(message)Reenvía un mensaje de estado a través del callback configurado

El callback opcional onToggle(isOpen) permite al host sincronizar su botón Search, y onLayout le permite redimensionar/ajustar el viewer cuando el Ribbon cambia de altura. Para la secuencia de inicio combinada del Viewer, Search y Annotation, consulte Quick Start.

Búsqueda desde JavaScript

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

El segundo argumento es coincidencia de palabra completa/exacta. El recuento de coincidencias llega en el callback: Search en sí mismo se envía al servidor y no devuelve nada útil, por lo que var n = objViewer.Search(keyword, false) siempre lee undefined — y una página construida de esa manera informa "nothing found" mientras el viewer resalta las coincidencias. Después del callback:

MethodResult
SearchMatchCount()Total de coincidencias individuales en el documento.
SearchSummary(false)[pageNumber, matchCount] entradas sin repintar.
SearchSummary(true)Mismo resumen y pinta los resaltados de página/miniatura.
GotoSearchMatch(index)Navega a un índice de coincidencia basado en cero.

La ruta del middleware utiliza search=<term> y exact=true|false y devuelve XML. Use la API del widget en lugar de analizar esa respuesta interna usted mismo.

Verificar capacidad de búsqueda

La respuesta de inicialización informa:

text
X-Doconut-Can-Search: 1

Después de la inicialización, objViewer.CanSearch() expone el mismo veredicto de formato/sesión. Devuelve false cuando el servidor envía 0; antes de la respuesta, o con un servidor más antiguo que omite el encabezado, por defecto es true.

Tres puertas independientes no deben confundirse:

PuertaPregunta
CanSearch() / response header¿El visor resuelto tiene una ruta de índice/búsqueda nativa?
AllowSearch¿Esta configuración de formato solicitó extracción de texto donde existe el interruptor?
LicenseCapability.Search¿La aplicación está autorizada para ejecutar la búsqueda y recibir los paquetes UI?

Un formato puede ser técnicamente buscable mientras la licencia actual niega la operación.

Habilitar extracción por formato

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // opcional: permite al usuario arrastrar una región y copiar su texto
});

AllowSearch y AllowCopy existen en PdfConfig, WordConfig, ExcelConfig y PptConfig. Las propiedades de Office delegan a sus PdfConfig anidados. Ambos por defecto son false.

Existen adaptadores de búsqueda nativa normales para PDF, Word, Excel, PowerPoint, TXT, Visio, correo electrónico, EPUB y MHT. XPS usa su ruta PDF por defecto. HTML y Microsoft Project se benefician de una redirección PDF basada en texto:

csharp
// DefaultRender = false → convertido a un PDF basado en texto → buscable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Para los renderizadores nativos, CanSearch() describe la capacidad del visor; no garantiza que un documento particular contenga texto utilizable. Un PDF cuyas páginas son solo imágenes escaneadas aún puede producir cero resultados nativos.

Comportamiento normal de búsqueda

El servidor intenta fuentes de búsqueda en este orden:

  1. Resultados del visor nativo del formato.
  2. Un índice de búsqueda preconstruido .srh.
  3. Un error/resultado vacío cuando no existen fuentes de búsqueda.

El índice .srh es el artefacto de búsqueda publicado junto a las imágenes de página cuando los documentos se sirven desde almacenamiento compartido, de modo que un nodo que nunca abrió el documento aún puede responder búsquedas — ver Despliegues Distribuidos.

CanSearch() puede ser verdadero para un visor buscable incluso cuando un documento particular no tiene capa de texto y por lo tanto no devuelve coincidencias.

Licenciamiento y comportamiento de UI

Una licencia Temporal/Demo activa otorga Búsqueda durante su período activo. Una licencia faltante y un archivo heredado TRIAL no otorgan capacidad de Búsqueda. Sin Búsqueda:

  • ReferenceCss y ReferenceScripts omiten los paquetes de búsqueda.
  • El middleware niega la búsqueda en lugar de devolver resultados con licencia.

Conduce la visibilidad de UI personalizada desde IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) y usa CanSearch() para el veredicto separado de formato/sesión.

Solución de problemas

SíntomaVerificación
Falta la barra de búsquedaCapacidad de búsqueda y IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() es falsoVisor de formato, ruta DefaultRender seleccionada y encabezado de respuesta de inicialización
La búsqueda devuelve cero para un PDF escaneadoEl documento no tiene capa de texto; use una fuente con texto o una proyección PDF que preserve el texto
La búsqueda funciona pero los resaltados están desplazadosRuta de renderizado, resolución, transformaciones del documento y cajas de palabras extraídas

¿Fue útil esta página?