Pesquisa

O Doconut Viewer fornece pesquisa normal 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 Viewer, não uma barra de ferramentas independente. A página completa deve incluir os recursos do Viewer, a barra de ferramentas do Viewer, a montagem do Viewer e o objViewer inicializado; a Ribbon de Pesquisa é então montada e anexada à mesma instância.

Pesquisa e anotação são recursos licenciados incorporados, não pacotes AddPlugin<T>(). Solicite os recursos de pesquisa de Viewer; suas tags são emitidas somente quando a licença concede Pesquisa. As visualizações MVC 5 não possuem @inject, portanto construa as tags no controlador e passe-as em ViewBag, juntamente com a bandeira de licença que a página necessita:

var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss = true,
    IncludeSearchCss = true
});
ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery        = true,
    IncludeViewerScripts = true,
    IncludeSearchScripts = true,
    IncludeSearchBar     = true
});
ViewBag.IsSearchEnabled = viewer.IsSearchEnabled;

Escreva-as na visualização com @Html.Raw(ViewBag.ViewerCss) e @Html.Raw(ViewBag.ViewerScripts). No Web Forms, exponha os mesmos valores do code-behind e escreva-os com <%= %>.

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

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

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Controles do visualizador, incluindo o botão que abre a Pesquisa -->
</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: '/',
        ResPath: 'doconut-res/images'
    });

    @if ((bool)ViewBag.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 Ribbon, de modo que uma chamada não protegida a doconutSearchBar(...) lançaria uma exceção e impediria a página do viewer de iniciar. No Web Forms, escreva a mesma proteção como <% if (IsSearchEnabled) { %> … <% } %>.

O componente injeta os grupos Find, Options e Results e gerencia a pesquisa, limpeza, contagem de correspondências e navegação de correspondência anterior/próxima. Uma barra de ferramentas do Viewer de propriedade do host só precisa alterná‑la:

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

Sua API pública é intencionalmente pequena:

O callback opcional onToggle(isOpen) permite que o host sincronize seu botão de Pesquisa, e onLayout permite redimensionar/ajustar o viewer quando a altura da Ribbon mudar. Para a sequência de inicialização combinada de Viewer, Pesquisa e Anotação, veja Quick Start.

Pesquisa a partir de 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 na callback: Search em si vai ao servidor e não retorna nada útil, então var n = objViewer.Search(keyword, false) sempre lê undefined — e uma página construída dessa forma relata "nothing found" enquanto o visualizador destaca as correspondências. Após a callback:

DocImage.axd responde search=<term> e exact=true|false com XML. Use a API do widget em vez de analisar essa resposta interna você mesmo.

Verificar capacidade de pesquisa

A resposta de inicialização relata:

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:

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

Habilitar extração por formato

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. Ambas padrão para false.

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

// 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 normal de pesquisa

O servidor tenta fontes de pesquisa nesta ordem:

1. Resultados nativos de ISearchableViewer.
2. Um índice de pesquisa .srh pré-construído.
3. Um erro/resultado vazio quando nenhuma fonte de pesquisa existe.

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

Licenciamento e comportamento da UI

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

• ReferenceCss e ReferenceScripts omitem os pacotes de pesquisa.
• DocImage.axd recusa solicitações de pesquisa em vez de retornar resultados.

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

Solução de problemas