Sök

Doconut Viewer tillhandahåller normal Search med hjälp av text som extraheras av formatvisaren eller en textbaserad PDF‑omdirigering. Det kräver Search‑licenskapacitet.

Aktivera sök‑UI

Search är en Viewer‑modul, inte ett fristående verktygsfält. Den kompletta sidan måste inkludera Viewer‑resurser, Viewer‑verktygsfält, Viewer‑montering och initierad objViewer; Search‑Ribbon monteras sedan och fästs på samma instans.

Search och annotation är inbyggda licensierade funktioner, inte AddPlugin<T>()‑paket. Begär sök‑resurserna från den injicerade Viewer; deras taggar emitteras endast när licensen beviljar Search.

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

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

Den inbäddade ribbon anropar samma JavaScript‑metoder som är tillgängliga för ett anpassat UI.

Behåll den kompletta Viewer‑sammansättningen synlig i markupen, initiera docViewer först, och fäst sedan den licensierade Ribbon:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer‑kontroller, inklusive knappen som öppnar 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>

Komponenten injicerar Find-, Options- och Results‑grupper och hanterar sökning, rensning, matchningsantal och föregående/nästa‑match‑navigering. Ett host‑ägt Viewer‑verktygsfält behöver bara växla den:

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

Dess offentliga API är avsiktligt litet:

Det valfria onToggle(isOpen)‑återanropet låter host‑en synkronisera sin Search‑knapp, och onLayout låter den ändra storlek/återanpassa visaren när Ribbon ändrar höjd. För den kombinerade Viewer‑, Search‑ och Annotation‑startsekvensen, se Snabbstart.

Sök från JavaScript

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

Det andra argumentet är hel‑ord/exakt matchning. Efter återanropet:

Middleware‑rutten använder search=<term> och exact=true|false och returnerar XML. Använd widget‑API:t snarare än att själv tolka det interna svaret.

Kontrollera sökkapacitet

Initieringssvaret rapporterar:

X-Doconut-Can-Search: 1

Efter initiering exponerar objViewer.CanSearch() samma format‑/sessionsverdict. Den returnerar false när servern skickar 0; före svaret, eller med en äldre server som utelämnar headern, är standardvärdet true.

Tre oberoende grindar får inte förväxlas:

Ett format kan tekniskt sett vara sökbart medan den aktuella licensen nekar operationen.

Aktivera extraktion per format

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // valfritt: låter användaren dra ett område och kopiera dess text
});

AllowSearch och AllowCopy finns på PdfConfig, WordConfig, ExcelConfig och PptConfig. Office‑egenskaperna delegaterar till deras inbäddade PdfConfig. Båda har standardvärdet false.

Normala inbyggda sök‑adaptrar finns för PDF, Word, Excel, PowerPoint, TXT, Visio, e‑post, EPUB och MHT. XPS använder sin PDF‑sökväg som standard. HTML och Microsoft Project drar nytta av en textbaserad PDF‑omdirigering:

// DefaultRender = false → konverteras till en textbaserad PDF → sökbar
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

För inbyggda renderare beskriver CanSearch() visarförmågan; den garanterar inte att ett specifikt dokument innehåller användbar text. En PDF vars sidor endast är skannade bilder kan fortfarande ge noll inbyggda resultat.

Normalt sökbeteende

Servern försöker sökkällor i följande ordning:

1. Inbyggda ISearchableViewer‑resultat.
2. Ett förbyggt .srh‑sökindex.
3. Ett fel-/tomt resultat när ingen sökkälla finns.

CanSearch() kan vara true för en sökbar viewer även när ett specifikt skannat dokument saknar textlager och därför returnerar inga träffar.

Licensiering och UI‑beteende

En aktiv Temporary/Demo‑licens beviljar Search under sin aktiva period. En saknad licens och ett äldre TRIAL‑fil ger ingen Search‑kapacitet. Utan Search:

• ReferenceCss och ReferenceScripts utelämnar sökpakketen.
• Middleware nekar sökning istället för att returnera licensierade resultat.

Styr anpassad UI‑synlighet via IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) och använd CanSearch() för det separata format‑/sessionsverdictet.

Felsökning