Suche

Der Doconut Viewer bietet die normale Suche mittels Text, der vom Format-Viewer extrahiert wird, oder einer textbasierten PDF-Umleitung. Er erfordert die Search Lizenzfähigkeit.

Such‑UI aktivieren

Suche ist ein Viewer‑Modul, kein eigenständiges Symbolleisten‑Element. Die komplette Seite muss die Viewer‑Ressourcen, die Viewer‑Symbolleiste, die Viewer‑Einbindung und das initialisierte objViewer enthalten; das Search‑Ribbon wird dann eingebunden und an dieselbe Instanz angehängt.

Suche und Annotation sind integrierte lizenzierte Funktionen, keine AddPlugin<T>()‑Pakete. Fordern Sie die Suchressourcen vom injizierten Viewer an; deren Tags werden nur ausgegeben, wenn die Lizenz Suche gewährt.

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

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

Das eingebettete Ribbon ruft dieselben JavaScript‑Methoden auf, die einer benutzerdefinierten UI zur Verfügung stehen.

Halten Sie die vollständige Viewer‑Zusammensetzung im Markup sichtbar, initialisieren Sie zuerst docViewer und hängen Sie anschließend das lizenzierte Ribbon an:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer-Steuerelemente, einschließlich der Schaltfläche, die die Suche öffnet -->
</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>

Die Komponente fügt die Gruppen Find, Options und Results ein und übernimmt die Suche, das Löschen, die Trefferzahlen sowie die Navigation zu vorherigen/nächsten Treffern. Eine vom Host verwaltete Viewer‑Symbolleiste muss sie lediglich umschalten:

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

Ihre öffentliche API ist bewusst klein:

Der optionale onToggle(isOpen)‑Callback ermöglicht es dem Host, seine Such‑Schaltfläche zu synchronisieren, und onLayout erlaubt es ihm, den Viewer zu skalieren/anzupassen, wenn das Ribbon die Höhe ändert. Für die kombinierte Startsequenz von Viewer, Search und Annotation siehe Schnellstart.

Suche aus JavaScript

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

Das zweite Argument ist die Ganzwort-/exakte Übereinstimmung. Nach dem Callback:

Die Middleware‑Route verwendet search=<term> und exact=true|false und gibt XML zurück. Verwenden Sie die Widget‑API, anstatt die interne Antwort selbst zu parsen.

Suchfähigkeit prüfen

Die Initialisierungsantwort meldet:

X-Doconut-Can-Search: 1

Nach der Initialisierung gibt objViewer.CanSearch() das gleiche Format-/Sitzungsurteil frei. Es gibt false zurück, wenn der Server 0 sendet; vor der Antwort oder bei einem älteren Server, der den Header weglässt, wird standardmäßig true verwendet.

Drei unabhängige Gates dürfen nicht verwechselt werden:

Ein Format kann technisch durchsuchbar sein, während die aktuelle Lizenz die Operation verweigert.

Extraktion pro Format aktivieren

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: ermöglicht dem Benutzer, einen Bereich zu ziehen und dessen Text zu kopieren
});

AllowSearch und AllowCopy existieren auf PdfConfig, WordConfig, ExcelConfig und PptConfig. Die Office‑Eigenschaften delegieren an ihr verschachteltes PdfConfig. Beide defaulten zu false.

Normale native‑Suchadapter existieren für PDF, Word, Excel, PowerPoint, TXT, Visio, E‑Mail, EPUB und MHT. XPS verwendet standardmäßig seinen PDF‑Pfad. HTML und Microsoft Project profitieren von einer textbasierten PDF‑Umleitung:

// DefaultRender = false → in ein textbasiertes PDF konvertiert → durchsuchbar
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Für native Renderer beschreibt CanSearch() die Viewer‑Fähigkeit; sie garantiert nicht, dass ein bestimmtes Dokument nutzbaren Text enthält. Ein PDF, dessen Seiten nur gescannte Bilder sind, kann dennoch null native Ergebnisse liefern.

Verhalten der normalen Suche

Der Server versucht Suchquellen in dieser Reihenfolge:

1. Native ISearchableViewer‑Ergebnisse.
2. Ein vorgefertigter .srh‑Suchindex.
3. Ein Fehler-/Leerergebnis, wenn keine Suchquelle existiert.

Der .srh‑Index ist das Suchartefakt, das zusammen mit den Seitenbildern veröffentlicht wird, wenn Dokumente aus gemeinsamem Speicher bereitgestellt werden, sodass ein Knoten, der das Dokument nie geöffnet hat, dennoch Suchanfragen beantworten kann — siehe Verteilte Bereitstellungen.

CanSearch() kann für einen durchsuchbaren Viewer wahr sein, selbst wenn ein bestimmtes gescanntes Dokument keine Textebene hat und daher keine Treffer zurückgibt.

Lizenzierung und UI‑Verhalten

Eine aktive Temporary/Demo‑Lizenz gewährt Suche während ihres aktiven Zeitraums. Eine fehlende Lizenz und eine veraltete TRIAL‑Datei gewähren keine Such‑Fähigkeit. Ohne Suche:

• ReferenceCss und ReferenceScripts lassen die Such‑Pakete weg.
• Die Middleware verweigert die Suche, anstatt lizenzierte Ergebnisse zurückzugeben.

Steuern Sie die Sichtbarkeit der benutzerdefinierten UI über IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) und verwenden Sie CanSearch() für das separate Format‑/Sitzungsurteil.

Fehlersuche