Suche

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

Such‑UI aktivieren

Search ist ein Viewer‑Modul, keine eigenständige Symbolleiste. Die komplette Seite muss die Viewer‑Ressourcen, die Viewer‑Symbolleiste, das Viewer‑Mount und das initialisierte objViewer enthalten; das Search‑Ribbon wird dann eingebunden und an dieselbe Instanz angehängt.

Search und Annotation sind integrierte lizenzierte Funktionen, keine AddPlugin<T>()‑Pakete. Fordern Sie die Such‑Ressourcen vom injizierten Viewer an; ihre Tags werden nur ausgegeben, wenn die Lizenz Search 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.

Behalten Sie die komplette Viewer‑Zusammensetzung im Markup bei, initialisieren Sie zuerst docViewer und hängen Sie anschließend das lizenzierte Ribbon an:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens 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>

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

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

Die öffentliche API ist bewusst klein:

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

Suche aus JavaScript

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

Das zweite Argument steht für 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.

Such‑Fähigkeit prüfen

Die Initialisierungsantwort meldet:

X-Doconut-Can-Search: 1

Nach der Initialisierung gibt objViewer.CanSearch() dasselbe Format‑/Sitzungs‑Urteil zurück. Es liefert false, wenn der Server 0 sendet; vor der Antwort oder bei einem älteren Server, der den Header weglässt, ist der Standardwert true.

Drei unabhängige Gateways 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: lets the user drag a region and copy its text
});

AllowSearch und AllowCopy existieren in PdfConfig, WordConfig, ExcelConfig und PptConfig. Die Office‑Eigenschaften delegieren an ihr verschachteltes PdfConfig. Beide haben standardmäßig den Wert false.

Normale native‑Such‑Adapter 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 → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

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

Normales Suchverhalten

Der Server versucht Suchquellen in dieser Reihenfolge:

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

CanSearch() kann für einen durchsuchbaren Viewer true 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 Search während ihres aktiven Zeitraums. Eine fehlende Lizenz und die Legacy‑Datei TRIAL gewähren keine Search‑Fähigkeit. Ohne Search:

• ReferenceCss und ReferenceScripts lassen die Search‑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‑/Sitzungs‑Urteil.

Fehlersuche