Suche

Native Textsuche in der Viewer‑Zusammensetzung

Der Doconut Viewer bietet die normale Suche, indem er Text verwendet, der vom Format‑Viewer extrahiert wird, oder eine textbasierte PDF‑Umleitung. Er erfordert die Search Lizenzfähigkeit.

Aktiviere die Such‑UI

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
@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 sichtbar, initialisieren Sie zuerst docViewer und hängen Sie anschließend das lizenzierte Ribbon an:

html
<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: '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 Skript des Ribbons weg, sodass ein ungeschützter doconutSearchBar(...) Aufruf einen Fehler auslöst und das Laden der Viewer‑Seite verhindert.

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

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

Die öffentliche API ist bewusst klein:

MethodeZweck
attach(objViewer)Verbinde das Ribbon mit dem initialisierten Viewer; einmal erforderlich
open() / close()Zeige das Ribbon an oder verstecke es; das Schließen löscht auch Hervorhebungen
reset()Lösche den aktuellen Begriff, die Trefferzahl und Hervorhebungen
isOpen()Gibt zurück, ob das Ribbon sichtbar ist
setStatus(message)Leite eine Statusnachricht ü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 bei Höhenänderungen des Ribbons neu skalieren/anpassen. Für die kombinierte Startsequenz von Viewer, Search und Annotation siehe Schnellstart.

Suche aus JavaScript

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) immer undefined liest — und eine auf diese Weise erstellte Seite meldet „nichts gefunden“, während der Viewer die Treffer hervorhebt. Nach dem Callback:

MethodeErgebnis
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.

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:

text
X-Doconut-Can-Search: 1

Nach der Initialisierung gibt objViewer.CanSearch() das gleiche Format‑/Sitzungsurteil zurück. Sie 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:

TorFrage
CanSearch() / response headerHat der aufgelöste Viewer einen nativen Index‑/Suchpfad?
AllowSearchHat diese Formatkonfiguration die Textextraktion angefordert, wo der Schalter vorhanden ist?
LicenseCapability.SearchIst die Anwendung autorisiert, 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

csharp
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 ihre verschachtelten 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:

csharp
// 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:

  1. Ergebnisse vom nativen Viewer des Formats.
  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 Dokument keine Textebene hat und daher keine Treffer zurückliefert.

Lizenzierung und UI‑Verhalten

Eine aktive Temporär‑/Demo‑Lizenz gewährt die Suche während ihres aktiven Zeitraums. Eine fehlende Lizenz und eine veraltete TRIAL‑Datei gewähren keine Suchfunktion. Ohne Suche:

  • ReferenceCss und ReferenceScripts lassen 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

SymptomPrüfung
Suchleiste fehltSuchfunktion und IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() ist falschFormat‑Viewer, ausgewählter DefaultRender Pfad und Initialisierungs‑Antwort‑Header
Suche liefert null für ein gescanntes PDFDas Dokument hat keine Textebene; verwenden Sie eine texttragende Quelle oder eine PDF‑Projektion, die Text erhält
Suche funktioniert, aber Hervorhebungen sind versetztRender‑Pfad, Auflösung, Dokument‑Transformationen und extrahierte Wort‑Boxen

War diese Seite hilfreich?