Pesquisa

Pesquisa de texto nativa na composição do visualizador

O Doconut visualizador fornece pesquisa padrão usando texto extraído pelo visualizador de formato ou um redirecionamento de PDF baseado em texto. Ele requer a capacidade de licença Search.

Habilitar a interface de pesquisa

A pesquisa é um módulo do visualizador, não uma barra de ferramentas independente. A página completa deve incluir os recursos do visualizador, a barra de ferramentas do visualizador, a montagem do visualizador e o objViewer inicializado; a faixa de pesquisa é então montada e anexada à mesma instância.

A pesquisa e a anotação são recursos licenciados incorporados, não pacotes AddPlugin<T>(). Solicite os recursos de pesquisa do Viewer injetado; suas tags são emitidas somente quando a licença concede pesquisa.

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
}))

A faixa incorporada chama os mesmos métodos JavaScript disponíveis para uma interface personalizada.

Mantenha a composição completa do visualizador visível no markup, inicialize docViewer primeiro e, em seguida, anexe a faixa licenciada:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Controles do visualizador, incluindo o botão 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>

O if do lado do servidor é importante: sem a capacidade de pesquisa, ReferenceScripts omite o script da faixa, de modo que uma chamada doconutSearchBar(...) desprotegida lançaria uma exceção e impediria a página do visualizador de iniciar.

O componente injeta os grupos Encontrar, Opções e Resultados e lida com pesquisa, limpeza, contagem de correspondências e navegação de correspondência anterior/próxima. Uma barra de ferramentas do visualizador de propriedade do host só precisa alterná‑la:

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

Sua API pública é intencionalmente pequena:

MétodoPropósito
attach(objViewer)Conecta a faixa ao visualizador inicializado; necessário uma vez
open() / close()Mostra ou oculta a faixa; fechar também limpa os realces
reset()Limpa o termo atual, a contagem de resultados e os realces
isOpen()Reporta se a faixa está visível
setStatus(message)Encaminha uma mensagem de status através do retorno configurado

O retorno opcional onToggle(isOpen) permite que o host sincronize seu botão de pesquisa, e onLayout permite redimensionar/ajustar o visualizador quando a altura da faixa mudar. Para a sequência de inicialização combinada do visualizador, pesquisa e anotação, veja Início Rápido.

Pesquisa a partir de JavaScript

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

O segundo argumento é correspondência de palavra inteira/exata. A contagem de correspondências chega no retorno: Search envia ao servidor e não retorna nada útil, portanto var n = objViewer.Search(keyword, false) sempre lê undefined — e uma página construída dessa forma relata "nada encontrado" enquanto o visualizador destaca as correspondências. Após o retorno:

MétodoResultado
SearchMatchCount()Total de correspondências individuais no documento.
SearchSummary(false)[pageNumber, matchCount] entradas sem repintura.
SearchSummary(true)Mesmo resumo e pinta os realces da página/miniatura.
GotoSearchMatch(index)Navega para um índice de correspondência baseado em zero.

A rota de intermediação usa search=<term> e exact=true|false e retorna XML. Use a API do widget em vez de analisar essa resposta interna você mesmo.

Verificar capacidade de busca

A resposta de inicialização relata:

text
X-Doconut-Can-Search: 1

Após a inicialização, objViewer.CanSearch() expõe o mesmo veredicto de formato/sessão. Ele retorna false quando o servidor envia 0; antes da resposta, ou com um servidor mais antigo que omite o cabeçalho, ele padrão para true.

Três portas independentes não devem ser confundidas:

PortaPergunta
CanSearch() / response headerO visualizador resolvido tem um caminho nativo de índice/busca?
AllowSearchEsta configuração de formato solicitou extração de texto onde a opção existe?
LicenseCapability.SearchO aplicativo está autorizado a executar busca e receber os pacotes de UI?

Um formato pode ser tecnicamente pesquisável enquanto a licença atual nega a operação.

Habilitar extração por formato

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // opcional: permite ao usuário arrastar uma região e copiar seu texto
});

AllowSearch e AllowCopy existem em PdfConfig, WordConfig, ExcelConfig e PptConfig. As propriedades do Office delegam para seus PdfConfig aninhados. Ambos padrão para false.

Adaptadores nativos de busca normais existem para PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB e MHT. XPS usa seu caminho PDF por padrão. HTML e Microsoft Project se beneficiam de um redirecionamento PDF baseado em texto:

csharp
// DefaultRender = false → convertido em um PDF baseado em texto → pesquisável
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Para renderizadores nativos, CanSearch() descreve a capacidade do visualizador; não garante que um documento específico contenha texto utilizável. Um PDF cujas páginas são apenas imagens escaneadas ainda pode produzir zero resultados nativos.

Comportamento de busca normal

O servidor tenta fontes de busca nesta ordem:

  1. Resultados do visualizador nativo do formato.
  2. Um índice de busca pré-construído .srh.
  3. Um erro/resultado vazio quando não existe fonte de busca.

O índice .srh é o artefato de busca publicado ao lado das imagens de página quando os documentos são servidos a partir de armazenamento compartilhado, de modo que um nó que nunca abriu o documento ainda pode responder a buscas — veja Implantações Distribuídas.

CanSearch() pode ser verdadeiro para um visualizador pesquisável mesmo quando um documento específico não tem camada de texto e, portanto, retorna nenhuma correspondência.

Licenciamento e comportamento da UI

Uma licença Temporária/Demo ativa concede Busca durante seu período ativo. Uma licença ausente e um arquivo legado TRIAL não concedem capacidade de Busca. Sem Busca:

  • ReferenceCss e ReferenceScripts omitem os pacotes de busca.
  • O middleware nega a busca em vez de retornar resultados licenciados.

Controle a visibilidade da UI personalizada a partir de IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) e use CanSearch() para o veredicto de formato/sessão separado.

Solução de Problemas

SintomaVerificação
Barra de busca está ausenteCapacidade de busca e IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() é falsoVisualizador de formato, caminho DefaultRender selecionado, e cabeçalho da resposta de inicialização
Busca retorna zero para um PDF escaneadoO documento não tem camada de texto; use uma fonte com texto ou uma projeção PDF que preserve o texto
Busca funciona mas os realces estão deslocadosCaminho de renderização, resolução, transformações do documento e caixas de palavras extraídas

Esta página foi útil?