Пошук

Текстовий пошук у Viewer

Doconut Viewer забезпечує звичайний пошук, використовуючи текст, витягнутий форматом переглядача, або перенаправлення PDF на основі тексту. Для цього потрібна можливість ліцензії Search.

Увімкнення інтерфейсу пошуку

Пошук — це модуль Viewer, а не окрема панель інструментів. Повна сторінка повинна містити ресурси Viewer, панель інструментів Viewer, монтування Viewer та ініціалізований objViewer; після цього Ribbon пошуку монтується та приєднується до того ж екземпляра.

Пошук і анотація — це вбудовані ліцензовані функції, а не пакети AddPlugin<T>(). Запросіть ресурси пошуку у впровадженого Viewer; їхні теги генеруються лише коли ліцензія надає Пошук.

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

Вбудований ribbon викликає ті ж JavaScript‑методи, що доступні для користувацького інтерфейсу.

Залиште повну композицію Viewer видимою в розмітці, спочатку ініціалізуйте docViewer, а потім приєднайте ліцензований Ribbon:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Елементи управління переглядачем, включаючи кнопку, що відкриває Search -->
</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>

Серверна сторона if має значення: без можливості Пошуку ReferenceScripts пропускає скрипт Ribbon, тому незахищений виклик doconutSearchBar(...) викличе помилку і зупинить запуск сторінки переглядача.

Компонент інжектує групи «Знайти», «Опції» та «Результати» та обробляє пошук, очищення, підрахунок збігів і навігацію попередній/наступний збіг. Панель інструментів Viewer, що належить хосту, лише потребує перемикання її:

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

Його публічний API навмисно невеликий:

МетодПризначення
attach(objViewer)Підключити Ribbon до ініціалізованого переглядача; потрібно один раз
open() / close()Показати або сховати Ribbon; закриття також очищає підсвічування
reset()Очистити поточний термін, кількість результатів та підсвічування
isOpen()Повідомити, чи Ribbon видимий
setStatus(message)Переслати повідомлення статусу через налаштований зворотний виклик

Необов'язковий зворотний виклик onToggle(isOpen) дозволяє хосту синхронізувати кнопку Пошуку, а onLayout дозволяє змінювати розмір/перепідлаштовувати переглядач, коли висота Ribbon змінюється. Для послідовності запуску комбінованих Viewer, Search та Annotation дивіться Швидкий старт.

Пошук з JavaScript

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

Другий аргумент — це пошук за цілим словом/точний збіг. Кількість збігів надходить у зворотний виклик: Search сам надсилає запит на сервер і не повертає корисних даних, тому var n = objViewer.Search(keyword, false) завжди читає undefined — і сторінка, створена таким чином, повідомляє «нічого не знайдено», хоча переглядач підсвічує збіги. Після зворотного виклику:

МетодРезультат
SearchMatchCount()Загальна кількість окремих збігів у документі.
SearchSummary(false)[pageNumber, matchCount] записів без перерисовки.
SearchSummary(true)Той самий підсумок і малює підсвічування сторінки/мініатюри.
GotoSearchMatch(index)Переходить до індексу збігу, починаючи з нуля.

Маршрут проміжного ПЗ використовує search=<term> та exact=true|false і повертає XML. Використовуйте API віджету замість того, щоб самостійно розбирати цю внутрішню відповідь.

Перевірка можливості пошуку

Відповідь ініціалізації повідомляє:

text
X-Doconut-Can-Search: 1

Після ініціалізації, objViewer.CanSearch() надає той самий результат формату/сесії. Він повертає false, коли сервер надсилає 0; до відповіді, або зі старішим сервером, який пропускає заголовок, за замовчуванням використовується true.

Три незалежних ворота не слід плутати:

ВоротаПитання
CanSearch() / response headerЧи має вирішений переглядач вбудований індекс/шлях пошуку?
AllowSearchЧи запитувала ця конфігурація формату вилучення тексту там, де існує перемикач?
LicenseCapability.SearchЧи має застосунок дозвіл виконувати пошук і отримувати UI‑пакети?

Формат може бути технічно пошуковим, хоча поточна ліцензія забороняє цю операцію.

Увімкнути вилучення за форматом

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // необов’язково: дозволяє користувачеві перетягнути область і скопіювати її текст
});

AllowSearch і AllowCopy існують на PdfConfig, WordConfig, ExcelConfig та PptConfig. Властивості Office делегуються їхнім вкладеним PdfConfig. Обидва за замовчуванням мають значення false.

Звичайні адаптери вбудованого пошуку існують для PDF, Word, Excel, PowerPoint, TXT, Visio, електронної пошти, EPUB та MHT. XPS за замовчуванням використовує свій шлях PDF. HTML та Microsoft Project отримують перевагу від перенаправлення на текстовий PDF:

csharp
// DefaultRender = false → перетворено у текстовий PDF → з можливістю пошуку
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Для вбудованих рендерерів, CanSearch() описує можливості переглядача; це не гарантує, що конкретний документ містить придатний текст. PDF, сторінки якого є лише сканованими зображеннями, все одно може давати нульові вбудовані результати.

Нормальна поведінка пошуку

Сервер пробує джерела пошуку у такому порядку:

  1. Результати з вбудованого переглядача формату.
  2. Попередньо створений .srh індекс пошуку.
  3. Помилка/порожній результат, коли жодне джерело пошуку не існує.

Індекс .srh — це артефакт пошуку, що публікується разом із зображеннями сторінок, коли документи подаються зі спільного сховища, тому вузол, який ніколи не відкривав документ, все ще може відповідати на пошуки — див. Розподілені розгортання.

CanSearch() може бути істинним для пошукового переглядача, навіть коли конкретний сканований документ не має текстового шару і тому не повертає збігів.

Ліцензування та поведінка UI

Активна тимчасова/демо‑ліцензія надає пошук протягом свого активного періоду. Відсутня ліцензія та застарілий файл TRIAL не надають можливості пошуку. Без пошуку:

  • ReferenceCss і ReferenceScripts пропускають пошукові пакети.
  • Проміжне ПЗ відхиляє пошук замість повернення ліцензованих результатів.

Керуйте видимістю користувацького UI через IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) і використовуйте CanSearch() для окремого результату формату/сесії.

Устранення неполадок

СимптомПеревірка
Пошукова панель відсутняМожливість пошуку та IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() хибнеПереглядач формату, обраний шлях DefaultRender та заголовок відповіді ініціалізації
Пошук повертає нуль для сканованого PDFДокумент не має текстового шару; використайте джерело з текстом або проекцію PDF, що зберігає текст
Пошук працює, але підсвічування зміщенеШлях рендерингу, роздільна здатність, перетворення документа та видобуті блоки слів

Чи була ця сторінка корисною?