搜索
在 Viewer 组合中进行原生文本搜索
Doconut Viewer 提供使用格式查看器提取的文本或基于文本的 PDF 重定向进行的普通搜索。它需要 Search 许可证功能。
启用搜索 UI
搜索是 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 中,从代码后置文件公开相同的值,并使用 <%= %> 写入。
嵌入的功能区调用与自定义 UI 相同的 JavaScript 方法。
在标记中保持完整的 Viewer 组合可见,首先初始化 docViewer,然后附加已授权的功能区:
<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: '/',
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) { %> … <% } %> 编写相同的防护。
该组件注入查找、选项和结果组,并处理搜索、清除、匹配计数以及上一条/下一条匹配的导航。宿主拥有的 Viewer 工具栏只需切换它:
searchBar.isOpen() ? searchBar.close() : searchBar.open();它的公共 API 刻意保持简洁:
| 方法 | 用途 |
|---|---|
attach(objViewer) | 将功能区连接到已初始化的 viewer;仅需一次 |
open() / close() | 显示或隐藏功能区;关闭时也会清除高亮 |
reset() | 清除当前搜索词、结果计数和高亮 |
isOpen() | 报告功能区是否可见 |
setStatus(message) | 通过配置的回调转发状态信息 |
可选的 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 —— 这样构建的页面会报告“未找到”,而查看器会高亮匹配项。回调之后:
| 方法 | 结果 |
|---|---|
SearchMatchCount() | 文档中总的单个匹配数。 |
SearchSummary(false) | 不重新绘制的 [pageNumber, matchCount] 条目。 |
SearchSummary(true) | 相同的摘要并绘制页面/缩略图高亮。 |
GotoSearchMatch(index) | 导航到基于零的匹配索引。 |
DocImage.axd 用 XML 回答 search=<term> 和 exact=true|false。请使用小部件 API,而不是自行解析该内部响应。
检查搜索功能
初始化响应报告:
X-Doconut-Can-Search: 1初始化后,objViewer.CanSearch() 暴露相同的格式/会话判定。当服务器发送 0 时,它返回 false;在响应之前,或在省略该头部的旧服务器上,默认返回 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() 即使在特定文档没有文本层、因此返回零匹配的情况下,对可搜索的查看器也可能为真。
许可和 UI 行为
有效的临时/演示许可证在其有效期内授予搜索功能。缺少许可证且使用旧版 TRIAL 文件则不提供搜索能力。没有搜索时:
ReferenceCss和ReferenceScripts省略搜索包。DocImage.axd拒绝搜索请求,而不是返回结果。
通过 IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) 控制自定义 UI 可见性,并使用 CanSearch() 获取单独的格式/会话判定。
故障排除
| 症状 | 检查 |
|---|---|
| 搜索栏缺失 | 搜索功能以及 IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() 为 假 | 格式查看器、选定的 DefaultRender 路径以及初始化响应头 |
| 搜索在扫描的 PDF 中返回零 | 文档没有文本层;请使用包含文本的来源或保留文本的 PDF 投影 |
| 搜索可用但高亮偏移 | 渲染路径、分辨率、文档变换以及提取的单词框 |
此页面对您有帮助吗?