Поиск

Нативный текстовый поиск в композиции Viewer

Doconut Viewer предоставляет обычный поиск, используя текст, извлечённый просмотрщиком формата, или перенаправление PDF на основе текста. Для этого требуется возможность лицензии Search.

Включить пользовательский интерфейс поиска

Поиск — это модуль Viewer, а не отдельная панель инструментов. Полная страница должна включать ресурсы Viewer, панель инструментов Viewer, монтирование Viewer и инициализированный objViewer; затем Ribbon поиска монтируется и присоединяется к тому же экземпляру.

Поиск и аннотация являются встроенными лицензированными функциями, а не пакетами AddPlugin<T>(). Запросите ресурсы поиска у внедрённого Viewer; их теги генерируются только когда лицензия предоставляет возможность Search.

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">
    <!-- Элементы управления просмотрщиком, включая кнопку, открывающую поиск -->
</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 (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 имеет значение: без возможности Search, ReferenceScripts опускает скрипт Ribbon, поэтому незащищённый вызов doconutSearchBar(...) вызовет исключение и остановит запуск страницы viewer.

Компонент внедряет группы Find, Options и Results и обрабатывает поиск, очистку, подсчёт совпадений и навигацию к предыдущему/следующему совпадению. Панель инструментов Viewer, принадлежащая хосту, только должна переключать её:

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

Его публичный API намеренно небольшой:

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

Опциональный callback onToggle(isOpen) позволяет хосту синхронизировать кнопку Search, а onLayout позволяет изменять размер/подгонять viewer, когда высота Ribbon меняется. Для последовательности запуска комбинированных Viewer, Search и Annotation см. Быстрый старт.

Поиск из JavaScript

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

Второй аргумент — поиск целых слов/точное совпадение. Количество совпадений приходит в callback: Search сам отправляется на сервер и возвращает ничего полезного, поэтому var n = objViewer.Search(keyword, false) всегда читает undefined — и страница, построенная таким образом, сообщает «ничего не найдено», в то время как viewer подсвечивает совпадения. После callback:

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

Маршрут промежуточного слоя использует search=<term> и exact=true|false и возвращает XML. Используйте API виджета вместо самостоятельного разбора этого внутреннего ответа.

Проверка возможности поиска

Ответ инициализации сообщает:

text
X-Doconut-Can-Search: 1

После инициализации, objViewer.CanSearch() раскрывает тот же verdict формата/сессии. Он возвращает 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, email, 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 — это артефакт поиска, публикуемый вместе с изображениями страниц, когда документы обслуживаются из общего хранилища, поэтому узел, который никогда не открывал документ, всё равно может отвечать на запросы поиска — см. Distributed Deployments.

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

Лицензирование и поведение UI

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

  • ReferenceCss и ReferenceScripts опускают поисковые пакеты.
  • Промежуточное ПО отказывает в поиске вместо возврата лицензированных результатов.

Управляйте видимостью пользовательского UI из IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) и используйте CanSearch() для отдельного verdict формата/сессии.

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

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

Была ли эта страница полезной?