PDFium Delphi Component 文件

TPdfDocumentSearch 类

单元: PDFium
在整篇文档中向前或向后流式获取文本匹配,同时只为一个页面保留本机句柄

方法

方法说明
Create用文本、选项、起始页面、方向和取消令牌初始化文档拥有的搜索
Destroy关闭保留的本机搜索句柄并与拥有文档分离
Next(out Match: TPdfDocumentSearchResult): Boolean返回下一个匹配项;在完成、取消或拥有文档关闭之后返回 False

属性

属性类型说明
CurrentPageInteger当前正在搜索的从 1 开始的页面
DirectionTPdfDocumentSearchDirection向前或向后的页面与匹配遍历
FinishedBoolean是否无法再产生结果
CancelledBoolean协作式取消是否已结束搜索
MatchCountUInt64已返回的匹配数量

TPdfDocumentSearchResult

字段类型说明
PageNumberInteger包含匹配项的从 1 开始的页面
StartIndexInteger从 0 开始的本机文本页字符索引
CountInteger匹配项中的本机文本页字符数量
TextWString从匹配范围提取的 Unicode 文本
RectanglesTPdfRectangles一个或多个合并后的 PDF 页面空间矩形,用于高亮显示

生命周期与并发

调用方拥有搜索并必须释放它。拥有文档只跟踪活动的搜索,以便在文档卸载之前关闭它们的本机句柄

对拥有文档的调用共享其 PDFium 锁。单个搜索实例仍必须由一个协调的调用方推进和释放,并且文档编辑不得与活动搜索重叠

参见

TPdf.CreateDocumentSearch, TPdf.FindFirst