Vyhledávání

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

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

Povolení uživatelského rozhraní vyhledávání

Vyhledávání je modul Vieweru, nikoli samostatná lišta nástrojů. Celá stránka musí zahrnovat zdroje Vieweru, lištu nástrojů Vieweru, připojení Vieweru a inicializovaný objViewer; Ribbon pro vyhledávání je pak připojen 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 Viewer; jejich značky jsou generovány pouze tehdy, když licence povoluje vyhledávání. MVC 5 pohledy nemají @inject, takže vytvořte značky v kontroleru a předejte je pomocí ViewBag, spolu s licenčním příznakem, který stránka potřebuje:

csharp
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();
    }
}

Zapište je do pohledu pomocí @Html.Raw(ViewBag.ViewerCss) a @Html.Raw(ViewBag.ViewerScripts). Ve Web Forms vystavte stejné hodnoty z code-behind a zapište je pomocí <%= %>.

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

Udržujte kompletní kompozici Vieweru viditelnou v markupu, nejprve inicializujte docViewer a poté 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: '/',
        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>

Na serverové straně 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čtení stránky vieweru. Ve Web Forms zapište stejnou ochranu jako <% if (IsSearchEnabled) { %> … <% } %>.

Komponenta vkládá skupiny Find, Options a Results a zpracovává vyhledávání, čištění, počty shod a navigaci na předchozí/další shodu. Hostitelská lišta Vieweru ji potřebuje pouze přepínat:

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

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

MetodaÚčel
attach(objViewer)Připojí Ribbon k inicializovanému vieweru; vyžadováno jednou
open() / close()Zobrazí nebo skryje Ribbon; zavření také vymaže zvýraznění
reset()Vymaže aktuální termín, počet výsledků a zvýraznění
isOpen()Nahlásí, zda je Ribbon viditelný
setStatus(message)Předá stavovou zprávu prostřednictvím nakonfigurovaného callbacku

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 kombinovanou sekvenci spouštění 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 určuje vyhledávání celých slov/přesnou shodu. Počet shod je předán 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 vytvořená tímto způsobem hlásí „nic nenalezeno“, zatímco prohlížeč zvýrazní 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 vykresluje zvýraznění stránky/miniaturní náhledy.
GotoSearchMatch(index)Naviguje na index shody číslovaný od nuly.

DocImage.axd odpovídá search=<term> a exact=true|false pomocí XML. Použijte widget API místo parsování této interní odpovědi sami.

Kontrola vyhledávacích schopností

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

text
X-Doconut-Can-Search: 1

Po inicializaci objViewer.CanSearch() zveřejňuje stejný formát/sesionní verdikt. 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í index/cestu pro vyhledávání?
AllowSearchPožadoval tento formát konfiguraci extrakce 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 vyhledá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ě mají výchozí hodnotu false.

Normální nativní vyhledávací adaptéry existují 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řevádí 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 pouze 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í.

CanSearch() může být pravda pro vyhledá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 vyhledávací schopnost. Bez vyhledávání:

  • ReferenceCss a ReferenceScripts vynechávají vyhledávací balíčky.
  • DocImage.axd odmítá požadavky na vyhledávání místo vracení výsledků.

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

Řešení problémů

SymptomKontrola
Vyhledávací lišta chybíSchopnost vyhledávání a IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
Hodnota CanSearch() je nepravdiváProhlíž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á?