Поиск
Нативный текстовый поиск в композиции Viewer
Doconut Viewer предоставляет обычный поиск, используя текст, извлечённый просмотрщиком формата, или переадресацию PDF на основе текста. Для этого требуется возможность лицензии Search.
Включить пользовательский интерфейс поиска
Поиск — это модуль Viewer, а не отдельная панель инструментов. Полная страница должна включать ресурсы Viewer, панель инструментов Viewer, монтирование Viewer и инициализированный objViewer; затем лента поиска монтируется и прикрепляется к тому же экземпляру.
Поиск и аннотация являются встроенными лицензированными функциями, а не пакетами 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 откройте те же значения из кода‑behind и запишите их с помощью <%= %>.
Встроенная лента вызывает те же методы JavaScript, доступные пользовательскому интерфейсу.
Сохраните полную композицию Viewer видимой в разметке, сначала инициализируйте docViewer, а затем прикрепите лицензированную ленту:
<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 исключает скрипт ленты, поэтому незащищённый вызов doconutSearchBar(...) вызовет ошибку и остановит запуск страницы Viewer. В Web Forms запишите ту же проверку как <% if (IsSearchEnabled) { %> … <% } %>.
Компонент внедряет группы Find, Options и Results и обрабатывает поиск, очистку, подсчёт совпадений и навигацию к предыдущему/следующему совпадению. Панель инструментов Viewer, принадлежащая хосту, только должна переключать её:
searchBar.isOpen() ? searchBar.close() : searchBar.open();Её публичный API преднамеренно небольшой:
| Метод | Назначение |
|---|---|
attach(objViewer) | Подключить ленту к инициализированному viewer; требуется один раз |
open() / close() | Показать или скрыть ленту; закрытие также очищает подсветки |
reset() | Очистить текущий запрос, количество результатов и подсветки |
isOpen() | Сообщить, видна ли лента |
setStatus(message) | Переслать сообщение о статусе через настроенный callback |
Опциональный callback onToggle(isOpen) позволяет хосту синхронно управлять кнопкой поиска, а onLayout позволяет изменять размер/подгонять viewer, когда высота ленты меняется. Для последовательности запуска комбинированных Viewer, Search и Annotation см. Быстрый старт.
Поиск из JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});Второй аргумент отвечает за поиск целых слов/точное совпадение. Количество совпадений приходит в обратный вызов: Search сам отправляется на сервер и возвращает ничего полезного, поэтому var n = objViewer.Search(keyword, false) всегда читает undefined — и страница, построенная таким образом, сообщает «nothing found», пока просмотрщик выделяет совпадения. После обратного вызова:
| Метод | Результат |
|---|---|
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() / response header | Имеет ли разрешённый просмотрщик собственный индекс/путь поиска? |
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, email, 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() может быть истинным для просмотрщика с поддержкой поиска, даже если у конкретного документа нет текстового слоя и он поэтому не возвращает совпадений.
Лицензирование и поведение UI
Активная временная/демо‑лицензия предоставляет поиск в течение своего активного периода. Отсутствующая лицензия и устаревший файл TRIAL не предоставляют возможности поиска. Без поиска:
ReferenceCssиReferenceScriptsопускают поисковые пакеты.DocImage.axdотклоняет запросы поиска вместо возврата результатов.
Управляйте видимостью пользовательского UI через IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) и используйте CanSearch() для отдельного вердикта формата/сессии.
Устранение неполадок
| Симптом | Проверка |
|---|---|
| Поисковая строка отсутствует | Возможность поиска и IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() ложно | Просмотрщик формата, выбранный путь DefaultRender и заголовок ответа инициализации |
| Поиск возвращает ноль для отсканированного PDF | В документе нет текстового слоя; используйте источник с текстом или проекцию PDF, сохраняющую текст |
| Поиск работает, но выделения смещены | Путь рендеринга, разрешение, трансформации документа и извлечённые рамки слов |
Была ли эта страница полезной?