Пошук
Вбудований текстовий пошук у складі Viewer
The Doconut Viewer забезпечує звичайний пошук, використовуючи текст, витягнутий формальним переглядачем, або перенаправлення PDF на основі тексту. Для цього потрібна можливість ліцензії Search.
Увімкнення інтерфейсу пошуку
Пошук — це модуль Viewer, а не окрема панель інструментів. Повна сторінка повинна містити ресурси Viewer, панель інструментів Viewer, монтування Viewer та ініціалізований objViewer; після цього Ribbon пошуку монтується та приєднується до того ж екземпляра.
Пошук та анотація — це вбудовані ліцензовані функції, а не пакети AddPlugin<T>(). Запросіть ресурси пошуку у впровадженого Viewer; їхні теги генеруються лише коли ліцензія дозволяє пошук.
@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:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Елементи керування переглядачем, включаючи кнопку, що відкриває пошук -->
</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(...) викличе помилку і зупинить запуск сторінки переглядача.
Компонент інжектує групи Find, Options та Results та обробляє пошук, очищення, підрахунок збігів і навігацію попередній/наступний збіг. Панель інструментів Viewer, що належить хосту, лише потребує перемикання її:
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
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 віджету замість власного розбору цієї внутрішньої відповіді.
Перевірка можливості пошуку
Відповідь ініціалізації повідомляє:
X-Doconut-Can-Search: 1Після ініціалізації, objViewer.CanSearch() розкриває той самий результат формату/сесії. Він повертає false, коли сервер надсилає 0; перед відповіддю, або зі старішим сервером, який пропускає заголовок, за замовчуванням використовується true.
Три незалежних ворота не слід плутати:
| Ворота | Питання |
|---|---|
CanSearch() / заголовок відповіді | Чи має вирішений переглядач вбудований шлях індексу/пошуку? |
AllowSearch | Чи запитувала ця конфігурація формату витяг тексту, де існує перемикач? |
LicenseCapability.Search | Чи має застосунок авторизацію виконувати пошук і отримувати UI‑пакети? |
Формат може бути технічно пошуковим, хоча поточна ліцензія забороняє цю операцію.
Увімкнути витяг за форматом
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:
// DefaultRender = false → перетворюється у текстовий PDF → можна шукати
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });Для нативних рендерерів, CanSearch() описує можливості переглядача; це не гарантує, що конкретний документ містить придатний текст. PDF, сторінки якого є лише сканованими зображеннями, все одно може давати нульові нативні результати.
Нормальна поведінка пошуку
Сервер перебирає джерела пошуку у такому порядку:
- Результати від нативного переглядача формату.
- Попередньо створений індекс пошуку
.srh. - Помилка/порожній результат, коли жодне джерело пошуку не існує.
Індекс .srh — це артефакт пошуку, що публікується разом із зображеннями сторінок, коли документи подаються з спільного сховища, тому вузол, який ніколи не відкривав документ, все ще може відповідати на пошуки — див. Розподілені розгортання.
CanSearch() може бути true для пошукового переглядача, навіть коли конкретний документ не має текстового шару і тому не повертає збігів.
Ліцензування та поведінка UI
Активна тимчасова/демо‑ліцензія надає пошук протягом свого активного періоду. Відсутня ліцензія та застарілий файл TRIAL не надають можливості пошуку. Без пошуку:
ReferenceCssіReferenceScriptsпропускають пошукові пакети.- Проміжне ПЗ відхиляє пошук замість повернення ліцензованих результатів.
Керуйте видимістю кастомного UI через IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) і використовуйте CanSearch() для окремого результату формату/сесії.
Устранення неполадок
| Симптом | Перевірка |
|---|---|
| Панель пошуку відсутня | Можливість пошуку та IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() є false | Переглядач формату, обраний шлях DefaultRender та заголовок відповіді ініціалізації |
| Пошук повертає нуль для сканованого PDF | Документ не має текстового шару; використайте джерело з текстом або проекцію PDF, що зберігає текст |
| Пошук працює, але виділення зміщені | Шлях рендерингу, роздільна здатність, трансформації документа та видобуті блоки слів |
Чи була ця сторінка корисною?