TPDFlib

核心对象、文档创建、文档管理

描述

TPDFlib(单元 Lib\PDFlibrary.pas)是 PDF Library for Delphi 的核心类。单个实例可同时承载一个或多个 PDF 文档:NewDocument 开始空文档,LoadFromFile 加载现有文档,SelectDocument 切换活动文档,DocumentCount 报告打开数量。所有绘制、文本、表单、注释、安全、签名、提取、渲染、打印和验证调用均在当前选定文档上操作

PDFlibrary 单元是总括单元:将其加入 uses 子句即可引入完整的公共接口,因此大多数程序只需 Uses PDFlibrary;

语法

Delphi

Uses PDFlibrary;

Var
  PDF: TPDFlib;
Begin
  PDF:= TPDFlib.Create;
  Try
    ...
  Finally
    PDF.Free;
  End;
End;

参数

Create / Destroy实例的生命周期;释放该实例会关闭所有打开的文档
NewDocument创建新的空白 PDF 文档并将其选中
LoadFromFile从磁盘加载现有 PDF(可选密码)并选择它
SelectDocument将另一个打开的文档设为活动文档
DocumentCount实例中当前打开的文档数量
SaveToFile将活动文档写入磁盘(增量更新会保持先前签名完整)
LastErrorCode最近一次错误的数字代码;上次调用成功时为 0
Abort / Aborted协作取消长时间运行的操作,并报告取消状态
OnProgress / OnOperationProgress面向长时间操作的粗细两级进度回调
OnPassword加密文档需要密码时向宿主请求密码
Logger接收结构化日志记录的可选 TPDFlibLogger 实例
MailProvider邮件函数使用的可选 IPDFlibMailProvider

备注

本文档中的参考页按任务逐一描述成员:文档管理、页面布局、矢量图形、字体和文本(包括 HTML 故事和文本流)、图像、表单和 JavaScript、注释和链接、大纲和目标、安全和数字签名、带标记 PDF、PDF/A 与 PDF/UA 一致性、内容提取和直接访问、渲染(SelectRenderer 选择 GDI+、Cairo 或 PDFium)、打印、预检报告以及通过 TPDFlibViewer 进行的查看器集成

大多数成员提供三种并行形式:TPDFlib 方法可接受 WideString、带 DL 前缀的 DLL 入口点(以及面向窄字符串调用方的带 A 后缀 ANSI 变体,参见 SetAnsiMode),以及 PDFlib library 自动化对象上的 ActiveX/COM 方法。每个成员页面并列显示 Delphi 和 DLL 语法

示例

// Create a document, draw one line of text and save it
Uses PDFlibrary;

Procedure Demo;
Var
  PDF: TPDFlib;
Begin
  PDF:= TPDFlib.Create;
  Try
    PDF.NewDocument;
    PDF.AddStandardFont('Helvetica');
    PDF.PrintText(50, 750, 'Hello from PDF Library for Delphi');
    PDF.SaveToFile('hello.pdf');
  Finally
    PDF.Free;
  End;
End;

另请参阅

DocumentationHome、GettingStarted、NewDocument、LoadFromFile、SelectDocument、DocumentCount、LastErrorCode、SelectRenderer、TPDFlibViewer、TPDFlibLogger