Sök

Inbyggd textsökning i Viewer-sammansättningen

Doconut Viewer ger normal sökning med text som extraheras av formatvisaren eller en textbaserad PDF‑omdirigering. Den kräver Search licensfunktion.

Aktivera sök‑UI

Sök är en Viewer-modul, inte ett fristående verktygsfält. Den kompletta sidan måste inkludera Viewer‑resurserna, Viewer‑verktygsfältet, Viewer‑monteringen och den initierade objViewer; Search Ribbon‑en 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 Viewer; deras taggar genereras endast när licensen beviljar Search. MVC 5‑vyer har ingen @inject, så bygg taggarna i kontrollern och skicka dem vidare via ViewBag, tillsammans med licensflaggan som sidan behöver:

csharp
public class ViewerController : Controller
{
    public ActionResult Index()
    {
        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;
        return View();
    }
}

Skriv dem i vyn med @Html.Raw(ViewBag.ViewerCss) och @Html.Raw(ViewBag.ViewerScripts). I Web Forms, exponera samma värden från kod‑bakom och skriv dem med <%= %>.

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

Behåll hela Viewer‑sammansättningen synlig i markup‑en, initiera docViewer först och fäst sedan det licensierade Ribbon‑et:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Visningskontroller, inklusive knappen som öppnar Sök -->
</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>

Server‑sidans if är viktig: utan Search‑funktionen utelämnar ReferenceScripts Ribbon‑skriptet, så ett oskyddat doconutSearchBar(...)‑anrop skulle kasta ett fel och hindra viewer‑sidan från att starta. I Web Forms, skriv samma skydd som <% if (IsSearchEnabled) { %> … <% } %>.

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 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 synligt
setStatus(message)Skicka vidare ett statusmeddelande via den konfigurerade återuppringningen

Den valfria onToggle(isOpen)‑återuppringningen 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‑startsekvensen, 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. Antalet träffar kommer i återanropet: Search själv går till servern och returnerar inget användbart, så var n = objViewer.Search(keyword, false) alltid läser undefined — och en sida byggd på det sättet rapporterar "nothing found" medan visaren markerar träffarna. Efter återanropet:

MetodResultat
SearchMatchCount()Totalt individuella träffar 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.

DocImage.axd svarar search=<term> och exact=true|false med XML. Använd widget‑API:t snarare än att själv tolka det interna svaret.

Kontrollera sökfunktion

Initieringssvaret rapporterar:

text
X-Doconut-Can-Search: 1

Efter initiering avslöjar objViewer.CanSearch() samma format-/sessionsverdict. Det returnerar false när servern skickar 0; före svaret, eller med en äldre server som utelämnar rubriken, standardas det till true.

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

GrindFråga
CanSearch() / response headerHar den upplösta visaren ett inbyggt index/sökväg?
AllowSearchBegärde detta formatkonfigurationsförfrågan textutdrag där växeln finns?
LicenseCapability.SearchÄr applikationen auktoriserad att utföra sökningar 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 nästlade 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‑vä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.

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

Licensiering och UI‑beteende

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

  • ReferenceCss och ReferenceScripts utelämnar sökpaketen.
  • DocImage.axd vägrar sökförfrågningar istället för att returnera resultat.

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

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 har inget textlager; använd en textbärande källa eller en PDF‑projektion som bevarar text
Sökning fungerar men markeringar är förskjutnaRenderingsväg, upplösning, dokumenttransformeringar och extraherade ordboxar

Var den här sidan hjälpsam?