Suche
Native Textsuche in der Viewer-Zusammensetzung
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 Such‑Ribbon wird dann eingebunden und an dieselbe Instanz angehängt.
Suche und Annotation sind integrierte lizenzierte Funktionen, keine AddPlugin<T>() Pakete. Fordern Sie die Such‑Ressourcen von Viewer an; deren Tags werden nur ausgegeben, wenn die Lizenz Suche gewährt. MVC‑5‑Views besitzen kein @inject, daher erstellen Sie die Tags im Controller und übergeben sie über ViewBag, zusammen mit dem Lizenz‑Flag, das die Seite benötigt:
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();
}
}Schreiben Sie sie in die View mit @Html.Raw(ViewBag.ViewerCss) und @Html.Raw(ViewBag.ViewerScripts). In Web Forms stellen Sie dieselben Werte aus dem Code‑Behind bereit und schreiben sie mit <%= %>.
Das eingebettete Ribbon ruft dieselben JavaScript‑Methoden auf, die einer benutzerdefinierten UI zur Verfügung stehen.
Behalten 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-Steuerelemente, einschließlich der Schaltfläche, die Search ö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 ((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>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öst und das Laden der Viewer‑Seite verhindert. In Web Forms schreiben Sie dieselbe Absicherung als <% if (IsSearchEnabled) { %> … <% } %>.
Die Komponente fügt die Gruppen Find, Options und Results ein und verarbeitet Suche, Löschen, Trefferzahlen sowie die Navigation zu vorherigen/ nächsten Treffern. Eine host‑eigene Viewer‑Symbolleiste muss sie nur umschalten:
searchBar.isOpen() ? searchBar.close() : searchBar.open();Die öffentliche API ist bewusst klein:
| Methode | Zweck |
|---|---|
attach(objViewer) | Verbinden Sie das Ribbon mit dem initialisierten Viewer; einmal 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 Ergebniszahl und Hervorhebungen |
isOpen() | Gibt zurück, ob das Ribbon sichtbar ist |
setStatus(message) | Leitet eine Statusmeldung über den konfigurierten Callback weiter |
Der optionale onToggle(isOpen) Callback ermöglicht es dem Host, seine Such‑Schaltfläche zu synchronisieren, und onLayout lässt ihn den Viewer neu skalieren/ anpassen, wenn das Ribbon seine Höhe ändert. 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 ist die Ganzwort-/exakte Übereinstimmung. Die Trefferanzahl kommt im Callback an: Search selbst geht zum Server und liefert nichts Nützliches, sodass var n = objViewer.Search(keyword, false) immer undefined liest — und eine auf diese Weise erstellte Seite meldet "nothing found", während der Viewer die Treffer hervorhebt. Nach dem Callback:
| Methode | Ergebnis |
|---|---|
SearchMatchCount() | Gesamte einzelne 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. |
DocImage.axd beantwortet search=<term> und exact=true|false mit XML. Verwenden Sie die Widget‑API, anstatt die interne Antwort selbst zu parsen.
Suchfähigkeit prüfen
Die Initialisierungsantwort meldet:
X-Doconut-Can-Search: 1Nach der Initialisierung legt objViewer.CanSearch() das gleiche Format‑/Sitzungs‑Urteil offen. 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 Format‑Konfiguration die Textextraktion angefordert, wo der Schalter existiert? |
LicenseCapability.Search | Ist die Anwendung berechtigt, die Suche auszuführen und die UI‑Pakete 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 defaulten zu 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 → 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 aus dem nativen Viewer des Formats.
- Ein vorgefertigter
.srhSuch‑Index. - Ein Fehler-/Leerergebnis, wenn keine Suchquelle existiert.
CanSearch() kann für einen durchsuchbaren Viewer wahr sein, selbst wenn ein bestimmtes 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.DocImage.axdverweigert Suchanfragen anstatt 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
| Symptom | Prüfung |
|---|---|
| Suchleiste fehlt | Suchfunktion und IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() ist falsch | Format‑Viewer, ausgewählter DefaultRender‑Pfad und Initialisierungs‑Antwort‑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, Dokument‑Transformationen und extrahierte Wort‑Boxen |
War diese Seite hilfreich?