Wyszukiwanie

Natywne wyszukiwanie tekstu w kompozycji Viewer

The Doconut Viewer zapewnia standardowe wyszukiwanie przy użyciu tekstu wyodrębnionego przez przeglądarkę formatu lub przekierowania PDF opartego na tekście. Wymaga możliwości licencyjnej Search.

Włącz interfejs wyszukiwania

Wyszukiwanie jest modułem Viewer, a nie samodzielnym paskiem narzędzi. Pełna strona musi zawierać zasoby Viewer, pasek narzędzi Viewer, montaż Viewer oraz zainicjowany objViewer; wówczas wstążka Search jest montowana i podłączana do tej samej instancji.

Wyszukiwanie i adnotacje są wbudowanymi funkcjami licencjonowanymi, a nie pakietami AddPlugin<T>(). Żądaj zasobów wyszukiwania z wstrzykniętego Viewer; ich tagi są emitowane tylko wtedy, gdy licencja zezwala na Search.

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
}))

Osadzona wstążka wywołuje te same metody JavaScript dostępne dla niestandardowego interfejsu użytkownika.

Utrzymaj pełną kompozycję Viewer widoczną w znacznikach, najpierw zainicjuj docViewer, a następnie podłącz licencjonowaną wstążkę:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Kontrolki przeglądarki, w tym przycisk otwierający wyszukiwanie -->
</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>

Po stronie serwera if ma znaczenie: bez możliwości Search, ReferenceScripts pomija skrypt wstążki, więc niechronione wywołanie doconutSearchBar(...) spowoduje błąd i zatrzyma uruchamianie strony viewer.

Komponent wstrzykuje grupy Find, Options i Results oraz obsługuje wyszukiwanie, czyszczenie, liczenie dopasowań i nawigację do poprzedniego/następnego dopasowania. Pasek narzędzi Viewer należący do hosta potrzebuje jedynie przełączenia go:

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

Jego publiczne API jest celowo małe:

MetodaCel
attach(objViewer)Połącz wstążkę z zainicjowanym viewer; wymagane jednorazowo
open() / close()Pokaż lub ukryj wstążkę; zamknięcie również usuwa podświetlenia
reset()Wyczyść bieżący termin, liczbę wyników i podświetlenia
isOpen()Zgłoś, czy wstążka jest widoczna
setStatus(message)Przekaż komunikat statusu przez skonfigurowane wywołanie zwrotne

Opcjonalne wywołanie zwrotne onToggle(isOpen) pozwala hostowi synchronizować przycisk Search, a onLayout umożliwia mu zmianę rozmiaru/dopasowanie viewer, gdy wstążka zmienia wysokość. Aby zobaczyć sekwencję uruchamiania połączonych Viewer, Search i Annotation, zobacz Quick Start.

Wyszukiwanie z JavaScript

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

Drugi argument określa dopasowanie całego słowa/dokładne. Liczba dopasowań przychodzi w wywołaniu zwrotnym: Search samodzielnie trafia na serwer i nie zwraca nic użytecznego, więc var n = objViewer.Search(keyword, false) zawsze odczytuje undefined — a strona zbudowana w ten sposób zgłasza „nic nie znaleziono”, podczas gdy viewer podświetla dopasowania. Po wywołaniu zwrotnym:

MetodaWynik
SearchMatchCount()Łączna liczba indywidualnych dopasowań w dokumencie.
SearchSummary(false)[pageNumber, matchCount] wpisów bez ponownego rysowania.
SearchSummary(true)Ten sam podsumowanie i rysuje podświetlenia stron/miniatur.
GotoSearchMatch(index)Przechodzi do dopasowania o indeksie zerowym.

Ścieżka pośrednia używa search=<term> i exact=true|false i zwraca XML. Użyj API widgetu zamiast samodzielnie parsować tę wewnętrzną odpowiedź.

Sprawdź możliwość wyszukiwania

Raport odpowiedzi inicjalizacji:

text
X-Doconut-Can-Search: 1

Po inicjalizacji, objViewer.CanSearch() udostępnia tę samą decyzję format/ sesja. Zwraca false, gdy serwer wysyła 0; przed odpowiedzią, lub przy starszym serwerze, który pomija nagłówek, domyślnie zwraca true.

Trzy niezależne bramki nie powinny być mylone:

BramkaPytanie
CanSearch() / response headerCzy rozwiązany podgląd posiada natywną ścieżkę indeksu/wyszukiwania?
AllowSearchCzy ta konfiguracja formatu żądała wyodrębniania tekstu w miejscu, gdzie istnieje przełącznik?
LicenseCapability.SearchCzy aplikacja jest uprawniona do wykonywania wyszukiwania i otrzymywania pakietów UI?

Format może być technicznie przeszukiwalny, podczas gdy bieżąca licencja odmawia tej operacji.

Włącz wyodrębnianie per format

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // opcjonalne: pozwala użytkownikowi zaznaczyć obszar i skopiować jego tekst
});

AllowSearch i AllowCopy istnieją na PdfConfig, WordConfig, ExcelConfig i PptConfig. Właściwości Office delegują do ich zagnieżdżonych PdfConfig. Oba domyślnie ustawiają false.

Standardowe natywne adaptery wyszukiwania istnieją dla PDF, Word, Excel, PowerPoint, TXT, Visio, e‑mail, EPUB i MHT. XPS domyślnie używa swojej ścieżki PDF. HTML i Microsoft Project korzystają z przekierowania PDF opartego na tekście:

csharp
// DefaultRender = false → przekształcone na PDF oparty na tekście → przeszukiwalny
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Dla natywnych renderów, CanSearch() opisuje możliwości podglądu; nie gwarantuje to, że konkretny dokument zawiera użyteczny tekst. PDF, którego strony są jedynie zeskanowanymi obrazami, może nadal zwracać zero natywnych wyników.

Normalne zachowanie wyszukiwania

Serwer próbuje źródeł wyszukiwania w następującej kolejności:

  1. Wyniki z natywnego podglądu formatu.
  2. Wstępnie zbudowany indeks wyszukiwania .srh.
  3. Błąd/pusty wynik, gdy nie istnieje żadne źródło wyszukiwania.

Indeks .srh jest artefaktem wyszukiwania publikowanym razem z obrazami stron, gdy dokumenty są serwowane z udostępnionego magazynu, więc węzeł, który nigdy nie otworzył dokumentu, może nadal odpowiadać na wyszukiwania — zobacz Rozproszone wdrożenia.

CanSearch() może być prawdziwe dla przeszukiwalnego podglądu, nawet gdy konkretny zeskanowany dokument nie ma warstwy tekstowej i dlatego nie zwraca dopasowań.

Licencjonowanie i zachowanie interfejsu UI

Aktywna licencja Tymczasowa/Demo przyznaje możliwość wyszukiwania w trakcie jej obowiązywania. Brak licencji oraz starszy plik TRIAL nie przyznają możliwości wyszukiwania. Bez wyszukiwania:

  • ReferenceCss i ReferenceScripts pomijają pakiety wyszukiwania.
  • Środowisko pośredniczące odrzuca wyszukiwanie zamiast zwracać wyniki na licencji.

Steruj widocznością niestandardowego UI z IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) i użyj CanSearch() dla oddzielnej decyzji format/ sesja.

Rozwiązywanie problemów

ObjawSprawdzenie
Pasek wyszukiwania jest nieobecnyMożliwość wyszukiwania oraz IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() jest fałszywePodgląd formatu, wybrana ścieżka DefaultRender oraz nagłówek odpowiedzi inicjalizacji
Wyszukiwanie zwraca zero dla zeskanowanego PDFDokument nie ma warstwy tekstowej; użyj źródła zawierającego tekst lub projekcji PDF zachowującej tekst
Wyszukiwanie działa, ale podświetlenia są przesunięteŚcieżka renderowania, rozdzielczość, przekształcenia dokumentu oraz wyodrębnione ramki słów

Czy ta strona była pomocna?