单元: PDFium
示例
Pdf.FileName := 'document.pdf';
Pdf.Password := 'password';
Pdf.Active := True; // open PDF document
Pdf.PageNumber := 1; // select page
ShowMessage(Pdf.Text); // extract text
Types
type TBookmark = record
Handle: FPDF_BOOKMARK;
Title: WString;
PageNumber: Integer;
Destination: TDestination;
DescendantCount: Integer;
IsOpen: Boolean;
Action: TPdfAction;
ActionPageNumber: Integer;
ActionDestination: TDestination;
ActionPath: WString;
HasColor: Boolean;
Color: TColor;
end;
type TBookmarks = array of TBookmark;
书签数据
type TDestination = record
Handle: FPDF_DEST;
Name: WString;
PageNumber: Integer;
ViewMode: TPdfDestinationViewMode;
ViewParameterCount: Integer;
ViewParameters: TPdfDestinationViewParameters;
HasX: Boolean;
X: Single;
HasY: Boolean;
Y: Single;
HasZoom: Boolean;
Zoom: Single;
end;
命名目标数据
type TPdfDestinationViewMode = (dvmUnknown, dvmXYZ, dvmFit, dvmFitHorizontal, dvmFitVertical, dvmFitRectangle, dvmFitBoundingBox, dvmFitBoundingBoxHorizontal, dvmFitBoundingBoxVertical);
type TPdfDestinationViewParameters = array [0..3] of Single;
目标视图模式及其有序的原生参数
type TLinkAnnotation = record
Handle: FPDF_LINK;
Rectangle: TPdfRectangle;
PageNumber: Integer;
Action: TPdfAction;
ActionPageNumber: Integer;
ActionPath: WString;
Points: array of TQuadrilateralPoint;
end;
type TLinkAnnotations = array of TLinkAnnotation;
type TQuadrilateralPoint = array [1..4] of TPdfPoint;
链接注释数据
type TPdfPermission = (permPrint, permModify, permCopy, permAnnotate, permFillForms, permAccessibility, permAssemble, permPrintHighQuality);
type TPdfPermissions = set of TPdfPermission;
从原生权限掩码解码得到的强类型文档权限标志
type TPdfDocumentMetadata = record
Title: WString;
Author: WString;
Subject: WString;
Keywords: WString;
Creator: WString;
Producer: WString;
CreationDate: WString;
ModifiedDate: WString;
end;
标准文档 Info 字典各字段的一次快照
type TObjectType = (otUnknown, otText, otPath, otImage, otShading, otForm);
确定 PDF 对象的类型
type TPageMode = (pmNone, pmOutline, pmThumbs, pmFullScreen, pmOptionalContentGroup, pmAttachments, pmUnknown);
确定 PDF 文档打开时的显示方式
- pmNone - 不显示文档大纲，也不显示缩略图
- pmOutline - 显示文档大纲
- pmThumbs - 显示缩略图
- pmFullScreen - 全屏模式，不显示菜单栏、窗口控件或其他任何窗口
- pmOptionalContentGroup - 显示可选内容组面板
- pmAttachments - 显示附件面板
- pmUnknown - 未知页面模式
type TPdfAction = (acUnsupported, acGoto, acGotoRemote, acUri, acLaunch);
确定与书签项关联的动作类型
- acUnsupported - 不支持的动作类型
- acGoto - 跳转到当前文档内的目标位置
- acGotoRemote - 跳转到另一个文档内的目标位置
- acUri - 统一资源标识符，包括网页和其他基于互联网的资源
- acLaunch - 启动应用程序或打开文件
type TPdfAnnotation = record
Subtype: TPdfAnnotationSubtype;
Flags: TPdfAnnotationFlags;
HasColor: Boolean;
Color: TColor;
ColorAlpha: Byte;
HasInteriorColor: Boolean;
InteriorColor: TColor;
InteriorColorAlpha: Byte;
HasAttachmentPoints: Boolean;
AttachmentPoints: TQuadrilateralPoint;
Rectangle: TPdfRectangle;
ContentsText: WString;
AuthorText: WString;
end;
注释数据
type TPdfAnnotationFlag = (afInvisible, afHidden, afPrint, afNoZoom, afNoRotate, afNoView, afReadOnly, afLocked, afToggleNoView);
type TPdfAnnotationFlags = set of TPdfAnnotationFlag;
注释标志
type TPdfAnnotationSubtype = (anUnknown, anText, anLink, anFreeText, anLine, anSquare, anCircle, anPolygon, anPolyLine, anHighlight, anUnderline, anSquiggly, anStrikeout, anStamp, anCaret, anInk, anPopup, anFileAttachment, anSound, anMovie, anWidget, anScreen, anPrinterMark, anTrapNet, anWaterMark, anThreed, anRichMedia, anXfaWidget, anRedact);
注释子类型
type TPdfBlendMode = (bmDefault, bmColor, bmColorBurn, bmColorDodge, bmDarken, bmDifference, bmExclusion, bmHardLight, bmHue, bmLighten, bmLuminosity, bmMultiply, bmNormal, bmOverlay, bmSaturation, bmScreen, bmSoftLight);
确定图层之间的混合方式
type TPdfDisplayMode = (dmSingleContinuous, dmTwoPageContinuous, dmTwoPageContinuousWithCover);
确定 PDF 文档页面的显示方式
- dmSingleContinuous - 在单列中连续显示页面
- dmTwoPageContinuous - 在两列中连续显示页面
- dmTwoPageContinuousWithCover - 首页单独显示，其余页面在两列中连续显示
type TPdfFeature = (feUnknown, feXfaForm, fePortableCollection, feAttachment, feSecurity, feSharedReview, feSharedFormAcrobat, feSharedFormFilesystem, feSharedFormEmail, fe3dAnnotation, feMovieAnnotation, feSoundAnnotation, feScreenMediaAnnotation, feScreenRichMediaAnnotation, feAttachmentAnnotation, feSignatureAnnotation);
由 OnUnsupportedFeature 事件报告的 PDF 文档特性
type TPdfFillMode = (fmNone, fmAlternate, fmWinding);
确定路径自相交时填充区域的形成方式
- fmNone - 无填充
- fmAlternate - 奇偶规则
- fmWinding - 非零环绕规则
type TPdfFormFieldFlag = (ffReadOnly, ffRequired, ffNoExport, ffMultiline, ffChoiceCombo, ffChoiceEdit, ffPassword, ffChoiceMultiSelect);
type TPdfFormFieldFlags = set of TPdfFormFieldFlag;
表单字段标志
type TPdfFormFieldInfo = record
Name: WString;
AlternateName: WString;
FieldType: TPdfFormFieldType;
Flags: TPdfFormFieldFlags;
OptionLabels: array of WString;
OptionSelected: array of Boolean;
FontSize: Single;
Checked: Boolean;
ExportValue: WString;
GroupCount: Integer;
GroupIndex: Integer;
end;
表单字段信息
type TPdfFormFieldType = (fiUnknown, fiPushButton, fiCheckBox, fiRadioButton, fiComboBox, fiListBox, fiTextField, fiSignature);
确定表单字段的类型
type TPdfFormType = (ftUnknown, ftNone, ftAcroForm, ftXfaFull, ftXfaForeground);
确定 PDF 文档中的表单类型
- ftUnknown - 未知表单类型
- ftNone - 文档中没有表单
- ftAcroForm - 表单使用 AcroForm 规范定义
- ftXfaFull - 表单使用完整的 XFA 规范定义
- ftXfaForeground - 表单使用 XFA 规范中的 XFAF 子集定义
type TPdfImage = record
Width: Integer;
Height: Integer;
Data: TBytes;
end;
PDF 图像对象的像素尺寸与数据
type TPdfLineCap = (lcDefault, lcButt, lcRound, lcProjectingSquare);
开放子路径端点所使用的形状
type TPdfLineJoin = (ljDefault, ljMiter, ljRound, ljBevel);
描边路径拐角处所使用的形状
type TPdfPoint = record
X, Y: Double;
end;
含 X 与 Y 坐标的点
type TPdfRectangle = record
Left, Top, Right, Bottom: Double;
end;
type TPdfRectangles = array of TPdfRectangle;
由 Left、Top、Right 和 Bottom 坐标构成的矩形区域
type TPdfFileIdentifierType = (fidPermanent, fidChanging);
Trailer 文件标识符选择器。fidPermanent 读取第一个 /ID 条目，fidChanging 读取第二个 /ID 条目
type TPdfPageBox = (pbMedia, pbCrop, pbBleed, pbTrim, pbArt);
PageBox、GetPageBox 和 SetPageBox 使用的页面字典盒选择器
type TPdfJavaScriptAction = record
Name: WString;
Script: WString;
end;
type TPdfJavaScriptActions = array of TPdfJavaScriptAction;
文档级 JavaScript 名树动作数据
type TPdfSignature = record
Content: TBytes;
Encoding: WString;
Reason: WString;
Time: WString;
Permission: Integer;
end;
数字签名信息
type TPdfIntegerArray = array of Integer;
结构树标记内容 ID 列表使用的整数数组
type TPdfSingleArray = array of Single;
文本对象字符位置设置方法使用的单精度浮点数组
type TPdfPrintPageRange = record
StartPage: Integer;
EndPage: Integer;
end;
type TPdfPrintPageRanges = array of TPdfPrintPageRange;
来自文档查看器首选项的以 1 为起始的打印页范围
type TPdfStructureElement = record
Level: Integer;
ParentIndex: Integer;
TypeName: WString;
ObjectType: WString;
Title: WString;
AlternateText: WString;
ActualText: WString;
Expansion: WString;
ID: WString;
Language: WString;
MarkedContentID: Integer;
MarkedContentIDs: TPdfIntegerArray;
ChildCount: Integer;
ChildMarkedContentIDs: TPdfIntegerArray;
AttributeCount: Integer;
ListNumbering: WString;
Scope: WString;
HasHeaders: Boolean;
HeadersIds: array of WString;
ColSpan: Integer;
RowSpan: Integer;
HasPrintField: Boolean;
NamespaceUri: WString;
RoleMappedNamespaceUri: WString;
RoleMappedTypeName: WString;
HasReference: Boolean;
HasAssociatedFile: Boolean;
AssociatedFileRelationship: WString;
AssociatedFileDescription: WString;
AnnotationSubtype: WString;
AnnotationContents: WString;
AnnotationAlternateText: WString;
IsArtifact: Boolean;
WidgetCount: Integer;
HasAppearance: Boolean;
LabelText: WString;
FieldAlternateName: WString;
end;
type TPdfStructureElements = array of TPdfStructureElement;
带标签 PDF 页面的扁平化逻辑结构元素数据
type TPdfFormSelectionRect = record
PageNumber: Integer;
Bounds: TPdfRectangle;
end;
原生表单文本选择所报告的、由调用方持有的页面空间矩形
type TPdfStructureReadOptions = record
MaxDepth: Integer;
MaxElements: Integer;
MaxAttributeValues: Integer;
DeadlineMilliseconds: Cardinal;
IncludeAttributes: Boolean;
class function Default: TPdfStructureReadOptions; static;
end;
迭代式原生结构树遍历的资源预算
type TPdfStructureReadStatus = record
Completed: Boolean;
ElementsVisited: Integer;
AttributeValuesVisited: Integer;
DepthLimitReached: Boolean;
ElementLimitReached: Boolean;
AttributeLimitReached: Boolean;
DeadlineReached: Boolean;
VisitorStopped: Boolean;
end;
结构遍历方法返回的完成与截断细节
type TPdfVersion = (pvUnknown, pv10, pv11, pv12, pv13, pv14, pv15, pv16, pv17);
PDF 文件或显式 SaveAs 目标的版本。可能的取值为：未知版本，PDF 1.0 至 1.7 版本。PDF 1.3 至 PDF 1.7 的显式 SaveAs 目标会依据所选 PDF 版本进行规范化与校验
type TPrintPaperHandling = (phUndefined, phSimplex, phDuplexFlipShortEdge, phDuplexFlipLongEdge);
打印纸张处理选项
- phUndefined - 未定义的纸张处理
- phSimplex - 单面打印
- phDuplexFlipShortEdge - 双面打印，沿短边翻转
- phDuplexFlipLongEdge - 双面打印，沿长边翻转
type TPdfPrintMode = (prEmf, prTextOnly, prPostScript2, prPostScript3, prPostScript2PassThrough, prPostScript3PassThrough, prEmfImageMasks, prPostScript3Type42, prPostScript3Type42PassThrough);
由 SetPdfPrintMode 选择的 Windows PDFium 打印输出模式
- prEmf - EMF 输出
- prTextOnly - 纯文本输出
- prPostScript2 - PostScript Level 2 输出
- prPostScript3 - PostScript Level 3 输出
- prPostScript2PassThrough - PostScript Level 2 直通输出
- prPostScript3PassThrough - PostScript Level 3 直通输出
- prEmfImageMasks - 带图像蒙版的 EMF 输出
- prPostScript3Type42 - PostScript Level 3 Type 42 输出
- prPostScript3Type42PassThrough - PostScript Level 3 Type 42 直通输出
type TRenderOption = (reAnnotations, reLcd, reNoNativeText, reGrayscale, reDebugInfo, reNoCatchException, reLimitCache, reHalftone, rePrinting, reReverseByteOrder, reNoSmoothText, reNoSmoothImage, reNoSmoothPath, reInvert, reNightDuotone);
type TRenderOptions = set of TRenderOption;
页面渲染标志
- reAnnotations - 渲染注释
- reLcd - 针对 LCD 显示优化的文本渲染
- reNoNativeText - 不使用某些平台上可用的原生文本输出
- reGrayscale - 灰度输出
- reDebugInfo - 需要获取调试信息时设置
- reNoCatchException - 不想捕获异常时设置
- reLimitCache - 限制图像缓存大小
- reHalftone - 图像拉伸时始终使用半调
- rePrinting - 为打印进行渲染
- reReverseByteOrder - 以反向字节序渲染；该标志仅在渲染到位图时生效
- reNoSmoothText - 关闭文本抗锯齿
- reNoSmoothImage - 关闭图像抗锯齿
- reNoSmoothPath - 关闭路径抗锯齿
- reInvert - 反转已渲染的 RGB 通道，作为 TPdfView 的低视力后渲染变换
- reNightDuotone - 将已渲染的亮度映射到 TPdfView.NightDuotoneInk 与 TPdfView.NightDuotonePaper
type TRotation = (ro0, ro90, ro180, ro270);
PDF 页面旋转。旋转方向为顺时针
- ro0 - 无页面旋转
- ro90 - 页面顺时针旋转 90 度
- ro180 - 页面顺时针旋转 180 度
- ro270 - 页面顺时针旋转 270 度
type TSaveOption = (saNone, saIncremental, saNoIncremental, saRemoveSecurity);
确定 PDF 文档的保存方式
- saNone - 默认保存
- saIncremental - 增量保存
- saNoIncremental - 非增量保存
- saRemoveSecurity - 移除安全
type TSearchOption = (seCaseSensitive, seWholeWord, seConsecutive);
type TSearchOptions = set of TSearchOption;
搜索标志
- seCaseSensitive - 区分大小写
- seWholeWord - 匹配整词
- seConsecutive - 不跳过当前匹配去查找下一个匹配
type TWebLink = record
Url: WString;
Rectangles: TPdfRectangles;
end;
type TWebLinks = array of TWebLink;
Web 链接的 URL 信息与边界区域
type WString = {$ifdef D2009PLUS} string {$else} WideString {$endif D2009PLUS};
宽字符串
Constants
const PointsPerInch: Integer = 72;
PDF 使用密度为每英寸 72 点的点单位
const FLAT_NORMALDISPLAY = 0;
const FLAT_PRINT = 1;
传递给 FlattenPage / FlattenAllPages 的扁平化配置。FLAT_NORMALDISPLAY 面向屏幕显示；FLAT_PRINT 面向打印输出
const FLATTEN_FAIL = 0;
const FLATTEN_SUCCESS = 1;
const FLATTEN_NOTHINGTODO = 2;
FlattenPage 返回的结果代码
type TPdfReadingUnit = record
Text: WString;
Kind: TPdfContentFragmentKind;
HeadingLevel: Integer;
Page: Integer;
Rects: TPdfRectangles;
FragmentIndex: Integer;
SentenceIndex: Integer;
IsAlternateText: Boolean;
Language: WString;
end
type TPdfReadingUnits = array of TPdfReadingUnit;
面向文本转语音与辅助听读工作流的句子级阅读单元
type TPdfWordBox = record
Text: WString;
StartIndex: Integer;
Count: Integer;
Rect: TPdfRectangle;
Page: Integer;
end
type TPdfWordBoxes = array of TPdfWordBox;
供同步阅读高亮使用的词级文本范围与页面矩形
type TPdfSpokenSpan = record
SpokenStart: Integer;
SpokenCount: Integer;
Page: Integer;
StartIndex: Integer;
Count: Integer;
end
type TPdfSpokenSpans = array of TPdfSpokenSpan;
把朗读引擎偏移映射回 PDF 页面文本的运行记录
type TPdfSpokenText = record
Text: WString;
Spans: TPdfSpokenSpans;
end
type TPdfSpokenTexts = array of TPdfSpokenText;
供朗读工作流与 TPdfReadingSession 使用的语音片段与来源映射
type TPdfReadingSessionState = (pssIdle, pssSpeaking, pssPaused);
TPdfReadingSession 报告的播放状态
Global Variables
var LibraryName: string = 'pdfium.dll';
当 EnableV8Engine 为 False 时使用的标准 PDFium 库名称。可在调用 LoadLibrary 之前修改
var EnableV8Engine: Boolean = False;
加载前设为 True，以便从匹配的 Win32 或 Win64 DLLs 目录中选择 pdfium.v8.dll