Sök

Inbyggd textsökning i Viewer-sammansättningen

Doconut Viewer erbjuder normal sökning med text som extraheras av formatvisaren eller en textbaserad PDF-omdirigering. Den kräver Search licenskapacitet.

Aktivera sök‑UI

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

Sök och annotering är inbyggda licensierade funktioner, inte AddPlugin<T>() paket. Begär sökresurserna från den injicerade Viewer; deras taggar genereras endast när licensen beviljar 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
}))

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:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Visningskontroller, 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: '/',
        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>

Server‑sidans if är viktig: utan Search‑kapaciteten utelämnar ReferenceScripts Ribbon‑skriptet, så ett oskyddat doconutSearchBar(...)‑anrop skulle kasta ett fel och hindra viewer‑sidan från att starta.

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

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

Det offentliga API‑et är avsiktligt litet:

MetodSyfte
attach(objViewer)Koppla Ribbon till den initierade viewern; krävs en gång
open() / close()Visa eller dölj Ribbon; stängning rensar också markeringar
reset()Rensa det aktuella sökordet, resultatantalet och markeringarna
isOpen()Rapportera om Ribbon är synlig
setStatus(message)Skicka vidare ett statusmeddelande via den konfigurerade callbacken

Den valfria onToggle(isOpen)‑callbacken låter hosten synkronisera sin Search‑knapp, och onLayout låter den ändra storlek/justera viewern när Ribbon ändrar höjd. För den kombinerade Viewer-, Search- och Annotation‑uppstartssekvensen, se Snabbstart.

Sök från JavaScript

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

Det andra argumentet är helord/exakt matchning. Matchningsantalet kommer i callbacken: Search själv går till servern och returnerar inget användbart, så var n = objViewer.Search(keyword, false) läser alltid undefined — och en sida byggd på det sättet rapporterar "nothing found" medan viewern markerar matchningarna. Efter callbacken:

MetodResultat
SearchMatchCount()Totalt antal individuella matchningar i dokumentet.
SearchSummary(false)[pageNumber, matchCount] poster utan ommålning.
SearchSummary(true)Samma sammanfattning och målar sid-/miniatyrmarkeringar.
GotoSearchMatch(index)Navigerar till ett nollbaserat matchningsindex.

Middleware‑rutten använder search=<term> och exact=true|false och returnerar XML. Använd widget‑API:t istället för att själv parsra det interna svaret.

Kontrollera sökfunktion

Initieringssvaret rapporterar:

text
X-Doconut-Can-Search: 1

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

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

GrindFråga
CanSearch() / response headerHar den upplösta visaren en inbyggd index-/sökväg?
AllowSearchBegärde denna formatkonfiguration textutvinning där växeln finns?
LicenseCapability.SearchÄr applikationen auktoriserad att utföra sökning och ta emot UI‑paketen?

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

Aktivera extraktion per format

csharp
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 delegerar 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:

csharp
// DefaultRender = false → konverterad 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. Resultat från formatets inbyggda visare.
  2. Ett förbyggt .srh sökindex.
  3. Ett fel-/tomt resultat när ingen sökkälla finns.

.srh‑indexet är sökartefakten som publiceras tillsammans med sidbilderna när dokument levereras från delat lagring, så en nod som aldrig öppnat dokumentet fortfarande kan besvara sökningar — se Distribuerade distributioner.

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

Licensiering och UI‑beteende

En aktiv Tillfällig/Demo‑licens ger sökning under sin aktiva period. En saknad licens och en äldre TRIAL‑fil ger ingen sökfunktion. Utan sökning:

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

Styr anpassad UI‑synlighet från IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) och använd CanSearch() för den separata format-/sessionsbedömningen.

Felsökning

SymptomKontroll
Sökfältet saknasSökfunktion och IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() är falsktFormatvisare, vald DefaultRender‑sökväg och initieringssvarets rubrik
Sökning returnerar noll för en skannad PDFDokumentet saknar textlager; använd en textbärande källa eller en PDF‑projektion som bevarar text
Sökning fungerar men markeringar är förskjutnaRenderingsökväg, upplösning, dokumenttransformeringar och extraherade ordboxar

Var den här sidan hjälpsam?