Vyhledávání

Nativní textové vyhledávání v sestavení Vieweru

Doconut Viewer poskytuje běžné vyhledávání pomocí textu extrahovaného formátovým prohlížečem nebo textového přesměrování PDF. Vyžaduje schopnost licence Search.

Povolit uživatelské rozhraní vyhledávání

Vyhledávání je modul Vieweru, nikoli samostatná lišta nástrojů. Kompletní stránka musí zahrnovat zdroje Vieweru, lištu nástrojů Vieweru, připojení Vieweru a inicializovaný objViewer; pak je Ribbon vyhledávání namontován a připojen k téže instanci.

Vyhledávání a anotace jsou vestavěné licencované funkce, ne balíčky AddPlugin<T>(). Požádejte o vyhledávací zdroje z injektovaného Viewer; jejich značky jsou generovány pouze když licence povolí vyhledávání.

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

Vložený ribbon volá stejné JavaScriptové metody dostupné pro vlastní UI.

Udržujte kompletní sestavení Vieweru viditelné v markupu, nejprve inicializujte docViewer a pak připojte licencovaný Ribbon:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Ovládací prvky prohlížeče, včetně tlačítka, které otevírá vyhledávání -->
</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>

Serverová if má význam: bez schopnosti vyhledávání ReferenceScripts vynechává skript Ribbonu, takže nechráněné volání doconutSearchBar(...) by vyvolalo výjimku a zastavilo načítání stránky vieweru.

Komponenta injektuje skupiny Find, Options a Results a zpracovává vyhledávání, čištění, počty shod a navigaci na předchozí/další shodu. Lišta nástrojů Vieweru vlastněná hostitelem ji stačí přepínat:

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

Jeho veřejné API je úmyslně malé:

MetodaÚčel
attach(objViewer)Připojit Ribbon k inicializovanému vieweru; vyžadováno jednou
open() / close()Zobrazit nebo skrýt Ribbon; zavření také vymaže zvýraznění
reset()Vymazat aktuální termín, počet výsledků a zvýraznění
isOpen()Nahlásit, zda je Ribbon viditelný
setStatus(message)Předat stavovou zprávu skrze nakonfigurovaný callback

Volitelný callback onToggle(isOpen) umožňuje hostiteli synchronizovat jeho tlačítko Vyhledávání a onLayout mu umožňuje změnit velikost/přizpůsobit viewer, když se výška Ribbonu změní. Pro kombinovaný startovací sekvenci Vieweru, Vyhledávání a Anotace viz Rychlý start.

Vyhledávání z JavaScriptu

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

Druhý argument je hledání celých slov/přesná shoda. Počet shod přichází v callbacku: Search sám jde na server a nevrací nic užitečného, takže var n = objViewer.Search(keyword, false) vždy čte undefined — a stránka postavená tímto způsobem hlásí „nic nenalezeno“, zatímco viewer zvýrazňuje shody. Po callbacku:

MetodaVýsledek
SearchMatchCount()Celkový počet jednotlivých shod v dokumentu.
SearchSummary(false)[pageNumber, matchCount] položky bez překreslení.
SearchSummary(true)Stejný souhrn a maluje zvýraznění stránky/miniaturního náhledu.
GotoSearchMatch(index)Naviguje na index shody číslovaný od nuly.

Middleware trasa používá search=<term> a exact=true|false a vrací XML. Použijte widget API místo parsování této interní odpovědi sami.

Zkontrolujte schopnost vyhledávání

Inicializační odpověď hlásí:

text
X-Doconut-Can-Search: 1

Po inicializaci objViewer.CanSearch() zveřejňuje stejný výsledek formátu/sesze. Vrací false, když server pošle 0; před odpovědí, nebo se starším serverem, který hlavičku vynechává, výchozí je true.

Tři nezávislé brány nesmí být zaměněny:

BránaOtázka
CanSearch() / response headerMá vyřešený prohlížeč nativní cestu k indexu/vyhledávání?
AllowSearchPožadovalo toto nastavení formátu extrakci textu tam, kde je přepínač?
LicenseCapability.SearchJe aplikace oprávněna provádět vyhledávání a přijímat UI balíčky?

Formát může být technicky prohledávatelný, zatímco aktuální licence operaci zakazuje.

Povolit extrakci podle formátu

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // volitelné: umožňuje uživateli táhnout oblast a zkopírovat její text
});

AllowSearch a AllowCopy existují na PdfConfig, WordConfig, ExcelConfig a PptConfig. Vlastnosti Office delegují na jejich vnořené PdfConfig. Obě výchozí jsou false.

Existují běžné nativní vyhledávací adaptéry pro PDF, Word, Excel, PowerPoint, TXT, Visio, e‑mail, EPUB a MHT. XPS ve výchozím nastavení používá svou PDF cestu. HTML a Microsoft Project těží z přesměrování na textový PDF:

csharp
// DefaultRender = false → převedeno na textový PDF → prohledávatelný
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Pro nativní renderery CanSearch() popisuje schopnost prohlížeče; nezaručuje, že konkrétní dokument obsahuje použitelné texty. PDF, jehož stránky jsou jen naskenované obrázky, může stále produkovat nulové nativní výsledky.

Normální chování vyhledávání

Server zkouší zdroje vyhledávání v tomto pořadí:

  1. Výsledky z nativního prohlížeče formátu.
  2. Předpřipravený .srh vyhledávací index.
  3. Chyba/prázdný výsledek, když neexistuje žádný zdroj vyhledávání.

.srh index je vyhledávací artefakt publikovaný spolu s obrázky stránek, když jsou dokumenty poskytovány ze sdíleného úložiště, takže uzel, který dokument nikdy neotevřel, může stále odpovídat na vyhledávání — viz Distribuovaná nasazení.

CanSearch() může být pravda pro prohledávatelný prohlížeč i když konkrétní dokument nemá textovou vrstvu a tudíž nevrací žádné shody.

Licencování a chování UI

Aktivní dočasná/demo licence poskytuje vyhledávání během svého platného období. Chybějící licence a starý soubor TRIAL neposkytují žádnou schopnost vyhledávání. Bez vyhledávání:

  • ReferenceCss a ReferenceScripts vynechávají vyhledávací balíčky.
  • Middleware odmítá vyhledávání místo vrácení licencovaných výsledků.

Řiďte viditelnost vlastního UI z IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) a použijte CanSearch() pro samostatný výsledek formátu/sesze.

Řešení problémů

PříznakKontrola
Vyhledávací lišta chybíSchopnost vyhledávání a IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() je nepravdaProhlížeč formátu, vybraná cesta DefaultRender a hlavička inicializační odpovědi
Vyhledávání vrací nulu pro naskenované PDFDokument nemá textovou vrstvu; použijte zdroj s textem nebo PDF projekci, která zachovává text
Vyhledávání funguje, ale zvýraznění jsou posunutáCesta renderování, rozlišení, transformace dokumentu a extrahované rámečky slov

Byla tato stránka užitečná?