搜索

在 Viewer 组合中的原生文本搜索

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

启用搜索 UI

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

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
}))

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

在标记中保持完整的 Viewer 组合可见,首先初始化 docViewer,然后附加已授权的 Ribbon:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- 查看器控件,包括打开 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>

服务器端的 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)通过配置的回调转发状态信息

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

从 JavaScript 进行搜索

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

第二个参数表示全词/精确匹配。匹配计数在回调中返回:Search 本身会发送到服务器但不返回有用信息,因此 var n = objViewer.Search(keyword, false) 总是读取 undefined —— 这样构建的页面会报告“未找到”,而 viewer 会高亮匹配项。回调之后:

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

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

检查搜索功能

初始化响应报告:

text
X-Doconut-Can-Search: 1

初始化后,objViewer.CanSearch() 暴露相同的格式/会话判定。当服务器发送 0 时返回 false;在响应之前,或使用省略该标头的旧服务器时,默认返回 true。

三个独立的门不可混淆:

门问题
CanSearch() / 响应标头已解析的查看器是否具有本机索引/搜索路径?
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、电子邮件、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 索引是与页面图像一起发布的搜索产物,当文档从共享存储提供时,即使从未打开文档的节点也能回答搜索——参见 分布式部署。

CanSearch() 即使在特定文档没有文本层且因此返回零匹配的情况下,也可能对可搜索的查看器为真。

许可和 UI 行为

活动的临时/演示许可证在其有效期间授予搜索功能。缺少许可证和旧版 TRIAL 文件则不提供搜索能力。没有搜索时:

  • ReferenceCss 和 ReferenceScripts 省略搜索包。
  • 中间件拒绝搜索,而不是返回已授权的结果。

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

故障排除

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

此页面对您有帮助吗?