Пошук
Рідний текстовий пошук у складі Viewer
Doconut Viewer забезпечує звичайний пошук, використовуючи текст, витягнутий форматом переглядача, або перенаправлення PDF на основі тексту. Для цього потрібна можливість ліцензії Search.
Увімкнути інтерфейс пошуку
Пошук — це модуль Viewer, а не окрема панель інструментів. Повна сторінка повинна містити ресурси Viewer, панель інструментів Viewer, монтування Viewer та ініціалізований objViewer; потім Ribbon пошуку монтується і підключається до того ж екземпляра.
Пошук і анотація — це вбудовані ліцензовані функції, а не пакети AddPlugin<T>(). Запросіть ресурси пошуку у Viewer; їхні теги генеруються лише коли ліцензія надає Пошук. У MVC 5 представленнях немає @inject, тому створіть теги у контролері та передайте їх через ViewBag разом із прапором ліцензії, необхідним сторінці:
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();
}
}Запишіть їх у представлення за допомогою @Html.Raw(ViewBag.ViewerCss) та @Html.Raw(ViewBag.ViewerScripts). У Web Forms відкрийте ті ж значення у код‑бекенді та запишіть їх за допомогою <%= %>.
Вбудований 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: '/',
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>Серверна сторона if має значення: без можливості пошуку ReferenceScripts пропускає скрипт Ribbon, тому незахищений виклик doconutSearchBar(...) викличе помилку і зупинить запуск сторінки переглядача. У Web Forms запишіть той же захист як <% if (IsSearchEnabled) { %> … <% } %>.
Компонент вставляє групи Find, Options та Results і обробляє пошук, очищення, підрахунок збігів та навігацію попередній/наступний збіг. Панель інструментів Viewer, що належить хосту, лише потребує перемикання її:
searchBar.isOpen() ? searchBar.close() : searchBar.open();Його публічний API навмисно невеликий:
| Method | Purpose |
|---|---|
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) | Переходить до індексу збігу, починаючи з нуля. |
DocImage.axd відповідає 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. - Помилковий/порожній результат, коли жодного джерела пошуку не існує.
CanSearch() може бути true для пошукового переглядача, навіть якщо конкретний документ не має текстового шару і, отже, не повертає збігів.
Ліцензування та поведінка інтерфейсу
Активна тимчасова/демо‑ліцензія надає можливість пошуку протягом свого активного періоду. Відсутня ліцензія та застарілий файл TRIAL не надають можливості пошуку. Без пошуку:
ReferenceCssтаReferenceScriptsпропускають пошукові пакети.DocImage.axdвідхиляє запити пошуку замість повернення результатів.
Керуйте видимістю користувацького інтерфейсу через IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) і використайте CanSearch() для окремого результату формату/сесії.
Устранення неполадок
| Симптом | Перевірка |
|---|---|
| Панель пошуку відсутня | Можливість пошуку та IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() є false | Переглядач формату, обраний шлях DefaultRender та заголовок відповіді ініціалізації |
| Пошук повертає нуль для сканованого PDF | У документі немає текстового шару; використайте джерело з текстом або проекцію PDF, що зберігає текст |
| Пошук працює, але підсвічування зміщене | Шлях рендерингу, роздільна здатність, трансформації документа та видобуті блоки слів |
Чи була ця сторінка корисною?