Doconut Viewer 提供使用格式查看器提取的文本或基于文本的 PDF 重定向的普通搜索。它需要 Search 许可证功能。

启用搜索 UI

Search 是 Viewer 的一个模块，而不是独立的工具栏。完整页面必须包含 Viewer 资源、Viewer 工具栏、Viewer 挂载点以及已初始化的 objViewer；随后会挂载并将 Search 功能区附加到同一实例上。

Search 和注释是内置的授权功能，而非 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
}))

嵌入的功能区调用与自定义 UI 相同的 JavaScript 方法。

在标记中保持完整的 Viewer 组合可见，首先初始化 docViewer，然后附加已授权的功能区：

html

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens 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>

该组件注入 Find、Options 和 Results 组，并处理搜索、清除、匹配计数以及上一条/下一条匹配的导航。托管的 Viewer 工具栏只需切换它即可：

javascript

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

它的公共 API 故意保持简洁：

方法	用途
`attach(objViewer)`	将功能区连接到已初始化的 viewer；仅需一次
`open()` / `close()`	显示或隐藏功能区；关闭时还会清除高亮
`reset()`	清除当前搜索词、结果计数和高亮
`isOpen()`	报告功能区是否可见
`setStatus(message)`	通过配置的回调转发状态消息

可选的 onToggle(isOpen) 回调允许宿主同步其 Search 按钮，onLayout 回调则在功能区高度变化时让其调整/重新适配 viewer。有关 Viewer、Search 和 Annotation 的组合启动顺序，请参阅快速入门。

从 JavaScript 进行搜索

javascript

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

第二个参数表示全词/精确匹配。回调完成后：

方法	结果
`SearchMatchCount()`	文档中所有单独匹配的总数。
`SearchSummary(false)`	返回 `[pageNumber, matchCount]` 条目，不进行重新渲染。
`SearchSummary(true)`	相同的摘要，并绘制页面/缩略图高亮。
`GotoSearchMatch(index)`	跳转到基于零的匹配索引。

中间件路由使用 search=<term> 和 exact=true|false，并返回 XML。请使用小部件 API，而不是自行解析内部响应。

检查搜索能力

初始化响应报告：

text

X-Doconut-Can-Search: 1

初始化后，objViewer.CanSearch() 会提供相同的格式/会话判断。当服务器返回 0 时返回 false；在收到响应之前，或在较旧的服务器未返回该标头时，默认返回 true。

三道独立的门不可混淆：

门	问题
`CanSearch()` / response header	解析后的 viewer 是否具有本机索引/搜索路径？
`AllowSearch`	此格式配置是否请求了文本提取（即开关存在）？
`LicenseCapability.Search`	应用程序是否被授权执行搜索并获取 UI 包？

即使格式在技术上可搜索，当前许可证仍可能拒绝该操作。

为每种格式启用提取

csharp

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: lets the user drag a region and copy its text
});

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 → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

对于本机渲染器，CanSearch() 描述的是 viewer 的能力；它并不保证特定文档包含可用的文本。页面仅为扫描图像的 PDF 仍可能返回零本机结果。

常规搜索行为

服务器按以下顺序尝试搜索来源：

本机 ISearchableViewer 结果。
预构建的 .srh 搜索索引。
当不存在搜索来源时返回错误/空结果。

CanSearch() 即使在特定文档没有文本层、因此返回零匹配的情况下，也可能对可搜索的 viewer 返回 true。

许可和 UI 行为

有效的临时/演示许可证在其有效期间授予 Search 权限。缺少许可证或使用旧的 TRIAL 文件则不授予 Search 能力。没有 Search 时：

ReferenceCss 和 ReferenceScripts 会省略搜索相关的资源包。
中间件会拒绝搜索，而不是返回已授权的结果。

通过 IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) 控制自定义 UI 的可见性，并使用 CanSearch() 获取独立的格式/会话判断。

故障排除

症状	检查
搜索栏缺失	检查搜索功能以及 `IncludeSearchCss`、`IncludeSearchScripts`、`IncludeSearchBar` 是否已启用
`CanSearch()` 为 false	检查格式查看器、所选的 `DefaultRender` 路径以及初始化响应标头
扫描的 PDF 搜索返回零	文档没有文本层；请使用包含文本的来源或保留文本的 PDF 投影
搜索可用但高亮偏移	检查渲染路径、分辨率、文档变换以及提取的单词框