Suche
Native Textsuche in der Viewer-Zusammensetzung
Der Doconut Viewer bietet normale Suche mittels Text, der vom Format-Viewer extrahiert wird, oder einer textbasierten PDF-Umleitung. Er erfordert die Search Lizenzfähigkeit.
Aktivieren der Such‑UI
Suche ist ein Viewer‑Modul, keine eigenständige Symbolleiste. 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 komplette Viewer‑Zusammensetzung im Markup sichtbar, initialisieren Sie zuerst docViewer und hängen Sie dann das lizenzierte Ribbon an:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Viewer-Steuerungen, 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: '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>Das serverseitige if ist wichtig: Ohne die Such‑Fähigkeit lässt ReferenceScripts das Ribbon‑Skript weg, sodass ein ungeschützter doconutSearchBar(...) Aufruf einen Fehler auslösen und das Laden der Viewer‑Seite verhindern würde.
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();Ihre öffentliche API ist bewusst klein:
| Methode | Zweck |
|---|---|
attach(objViewer) | Verbinden Sie das Ribbon mit dem initialisierten Viewer; einmalig erforderlich |
open() / close() | Zeigt das Ribbon an oder blendet es aus; beim Schließen werden auch Hervorhebungen gelöscht |
reset() | Löscht den aktuellen Begriff, die Trefferzahl und Hervorhebungen |
isOpen() | Gibt zurück, ob das Ribbon sichtbar ist |
setStatus(message) | Leitet eine Statusnachricht über den konfigurierten Callback weiter |
Der optionale onToggle(isOpen) Callback ermöglicht es dem Host, seine Suchschaltfläche zu synchronisieren, und onLayout lässt ihn den Viewer bei einer Höhenänderung des Ribbons neu skalieren/anpassen. Für die kombinierte Startsequenz von Viewer, Suche und Annotation siehe Schnellstart.
Suche aus JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});Das zweite Argument steht für Ganzwort-/Exakt‑Übereinstimmung. Die Trefferzahl wird im Callback übergeben: Search selbst geht zum Server und liefert nichts Nützliches, sodass var n = objViewer.Search(keyword, false) stets undefined ausliest — und eine auf diese Weise erstellte Seite meldet „nichts gefunden“, während der Viewer die Treffer hervorhebt. Nach dem Callback:
| Methode | Ergebnis |
|---|---|
SearchMatchCount() | Gesamtzahl einzelner Treffer im Dokument. |
SearchSummary(false) | [pageNumber, matchCount] Einträge ohne Neuzeichnen. |
SearchSummary(true) | Gleiche Zusammenfassung und malt Seiten-/Thumbnail‑Hervorhebungen. |
GotoSearchMatch(index) | Navigiert zu einem nullbasierten Treffer‑Index. |
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.
Suchfunktion prüfen
Die Initialisierungsantwort meldet:
X-Doconut-Can-Search: 1Nach der Initialisierung gibt objViewer.CanSearch() das gleiche Format-/Sitzungsurteil aus. 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 Tore dürfen nicht verwechselt werden:
| Tor | Frage |
|---|---|
CanSearch() / response header | Hat der aufgelöste Viewer einen nativen Index-/Suchpfad? |
AllowSearch | Hat diese Formatkonfiguration die Textextraktion angefordert, wo der Schalter vorhanden ist? |
LicenseCapability.Search | Ist die Anwendung berechtigt, die Suche auszuführen und die UI‑Bündel zu erhalten? |
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: lässt den Benutzer einen Bereich ziehen und dessen Text kopieren
});AllowSearch und AllowCopy existieren auf PdfConfig, WordConfig, ExcelConfig und PptConfig. Die Office‑Eigenschaften delegieren an ihr verschachteltes PdfConfig. Beide haben standardmäßig 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.
Normales Suchverhalten
Der Server versucht Suchquellen in dieser Reihenfolge:
- Ergebnisse vom nativen Viewer des Formats.
- Ein vorgefertigter
.srhSuchindex. - 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 Temporär‑/Demo‑Lizenz gewährt Suche während ihres aktiven Zeitraums. Eine fehlende Lizenz und eine veraltete TRIAL‑Datei gewähren keine Suchfunktion. Ohne Suche:
ReferenceCssundReferenceScriptslassen die Such‑Bundles 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
| Symptom | Prüfung |
|---|---|
| Suchleiste fehlt | Suchfunktion und IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() ist falsch | Format‑Viewer, ausgewählter DefaultRender Pfad und Initialisierungsantwort‑Header |
| Suche liefert null für ein gescanntes PDF | Das Dokument hat keine Textebene; verwenden Sie eine texthaltige Quelle oder eine PDF‑Projektion, die Text bewahrt |
| Suche funktioniert, aber Hervorhebungen sind versetzt | Render‑Pfad, Auflösung, Dokumententransformationen und extrahierte Wortboxen |
War diese Seite hilfreich?