PDFlib 7.0.1 控件使用手册：C++、Java、PHP等多语言支持

需积分: 10 48 浏览量更新于2024-07-18 收藏 2.47MB PDF 举报

"PDFlib-API" PDFlib是一款强大的库，用于在多种编程语言中动态生成PDF文档，包括C++、C、Java、PHP、Python等。这个API提供了全面的功能，允许开发者创建复杂的PDF文档，实现自定义布局、文本、图像、图形和元数据的集成。PDFlib 7.0.1是该库的一个版本，适用于各种编程环境，如Cobol、Perl、Ruby和Tcl等。 PDFlib API的核心功能包括： 1. **文本处理**：支持各种字体、字号和排版，能够处理Unicode字符集，确保全球语言的支持。 2. **图像集成**：可以插入JPEG、PNG、TIFF等多种格式的图像，也可以嵌入PDF中的其他页面作为图像。 3. **图形绘制**：提供直线、曲线、矩形、椭圆等基本图形绘制功能，还支持自定义路径和贝塞尔曲线。 4. **链接与交互**：创建内部和外部链接，支持按钮、表单字段和其他交互元素。 5. **元数据**：添加和编辑PDF文档的元数据，如标题、作者和关键词。 6. **安全性**：设置文档访问权限，如打印、复制和编辑限制。 7. **预览与输出**：在内存中生成PDF，或者直接输出到文件或网络流。 8. **跨平台兼容性**：在Windows、Linux、macOS等操作系统上运行。该手册详细介绍了如何在不同编程语言中使用PDFlib API，为开发者提供了丰富的示例代码和使用指南。此外，PDFlib GmbH提供了技术支持，包括邮件列表和专门的联系方式，方便用户获取帮助和解决问题。 PDFlib GmbH是这个库的开发者和版权所有者，他们保留所有权利，但允许内部使用目的的复制。尽管PDFlib尽力提供准确和最新的信息，但他们不对手册中的错误或不准确性承担责任，也不提供任何形式的保证。PDFlib和其徽标是公司的注册商标，而其他如Adobe、Microsoft、Apple等公司的产品名称和技术是各自公司的商标。 PDFlib-API是一个强大的工具，适合需要在应用程序中生成专业品质PDF文档的开发者。通过这个API，开发者可以轻松地将PDF生成功能集成到他们的软件中，无论是在网页应用、桌面程序还是移动平台上。

第 2 章：常规函数

2.3 文档函数

C++ Java int begin_document(String filename, String optlist)

Perl PHP int PDF_begin_document(resource p, string filename, string optlist)

C int PDF_begin_document(PDF *p, const char *filename, int len, const char *optlist)

C++ void begin_document_callback(size_t (*writeproc) (PDF *p, void *data, size_t size), string optlist)

C void PDF_begin_document_callback(PDF *p,

size_t (*writeproc) (PDF *p, void *data, size_t size), const char *optlist)

根据各种选项创建新的 PDF 文档。

filename （名称字符串，但只在 Windows 上支持 Unicode 文件名）将生成 PDF 输出文件

的绝对或相对文件名。如果 filename 为空，则将在内存中生成 PDF 文档，而不创建文件，

因而只能从客户端通过 PDF_get_buffer( ) 函数来获取生成的 PDF 数据。特殊文件名 »–« 可用

来在 stdout 通道上生成 PDF。在 Windows 上，可以使用 UNC 路径或映射网络驱动器。

len （仅用于 C 语言绑定）UTF-16 字符串的 filename 长度（以字节为单位）。如果 len=0，

则必须提供以 null 终结的字符串。

writeproc （仅用于 C 和 C++）C 回调函数，可由 PDFlib 调用，以提交生成的（部分）PDF

数据。

optlist 选项列表，根据表 2.3 指定文档选项。 PDF_end_document( ) 中指定的选项优先于

PDF_begin_document( ) 中指定的相同选项。可以使用下列选项：

附件、autoxmp、

compatibility

、destination、errorpolicy、flush、groups、hypertext-encoding、

inmemory、labels、lang、linearize、master- password、metadata、moddate、openmode、

optimize、pagelayout、pdfa、pdfx、permissions、recordsize、search、tagged、

tempdirname

、

temp-filenames、 uri、 user-password、 viewer-preferences。

返回值 -1 （在 PHP 中：0）无错误，否则为 1。如果 filename 为空，此函数始终都能成功运行，从

返回 -1 （在 PHP 中：0）错误值。

详细说明此函数使用提供的 filename 创建新 PDF 文件。 PDFlib 将尝试使用给定文件名打开文件，并

在 PDF 文档完成时关闭文件。

PDF_begin_document_callback( ) 会在内存中打开新 PDF 文档，而不写入磁盘文件。作为

提供的回调函数， writeproc 必须返回写入的字节数。如果返回值不匹配 PDFlib 提供的 size

自变量，将引发异常。 writeproc 的调用频率可由 flush 选项配置。

范围对象；如果文件可以成功打开，此函数将为文档范围的起点；必须始终与对应的 PDF_end_

document( ) 调用成对使用。

绑定 C、 C++、 Java、 JScript：确保正确地转义反斜线路径分隔符。例如，以下路径指示网络驱

动器上的一个文件：\\\\malik\\rp\\foo.pdf。

PDF_begin_document_callback( ) 只能用于 C 和 C++。提供的 writeproc 必须为 C 语言函数，

而非 C++。

2.3 文档函数

C++ Java void end_document(String optlist)

Perl PHP PDF_end_document(resource p, string optlist)

C void PDF_end_document(PDF *p, const char *optlist)

关闭生成的 PDF 文档并应用各种选项。

optlist 选项列表，根据表 2.3 指定文档选项。 PDF_end_document( ) 中指定的选项优先于

PDF_begin_document( ) 中指定的相同选项。可以使用下列选项：

action、attachment-password 附件、autoxmp、destination、destname、hypertext-encoding、

labels、 metadata、 moddate、 openmode、 pagelayout、 search、 uri、 viewer-preferences。

详细说明此函数完成 PDF 文档生成，释放所有文档相关的资源；如果已经用 PDF_begin_document( )

打开了文档，此函数还可关闭输出文件。无论使用何种方法打开 PDF 文档，客户端完成页

面生成操作时都必须调用此函数。

在内存中生成文档时（而不在文件中），调用此函数后仍将保留文档缓冲区（因此，可

使用 PDF_get_buffer( ) 提取数据），并将在下次调用 PDF_begin_document( ) 或者 PDFlib 对

象在 PDF_delete( ) 中的超出范围时释放文档缓冲区。

范围文档；此函数终结文档范围，应始终与 PDF_begin_document( ) 或 PDF_begin_document_

callback( ) 调用成对使用。

表 2.3 PDF_begin_document( ) 和 PDF_end_document( ) 的文档选项

选项描述

action

（动作列表； PDF/A 不支持）下列一个或多个事件的文档动作列表。默认值：空列表。

open 打开文档时执行的动作。由于在 Acrobat 中的执行顺序，文档级 JavaScript 不能用于 open

动作。

didprint/didsave/willclose/willprint/willsave

(PDF 1.4) 将在打印 / 保存文档之后及关闭 / 打印 / 保存文档之前执行的 JavaScript 动作。

attachment-

password

（字符串； PDF 1.6 ；如果设置了 userpassword 或 masterpassword 则会忽略此选项）将使用所提供

的字符串作为密码对文件附件加密。文档的其余部分不加密。

附件（选项列表的列表）指定文档级的文件附件（与限定于页面上特定位置的附件注释相对）。

在 PDF_begin_document( ) 和 PDF_end_document( ) 中均可提供文件附件。支持的选项：

filename （名称字符串；是必需的）文件名。支持 UTF-16 文件名。

description（超文本字符串； PDF 1.6）与文件关联的描述性文本。

autoxmp

（布尔型；在 PDF/A 模式下将强制为 true）如果为 true， PDFlib 将从文档信息域创建 XMP 文档元数

据（参见第 144 页上的第 12.2 节“XMP 元数据”）。默认值：false

compatibility

（关键字）对于 Acrobat 4、 5、 6、 7 或 8，将文档的 PDF 版本设置为以下字符串之一：1.3、 1.4、

1.5、 1.6 或 1.7。如果使用 pdfx 或 pdfa 选项，将忽略此选项。默认值：1.6

destination

（选项列表；如果已指定打开动作，将忽略此选项）选项列表，根据表 10.3 指定文档打开动作。

destname

（超文本字符串；如果已指定 destination 选项，将忽略此选项）目标名称，已使用 PDF_add_

nameddest( ) 定义并将用作文档打开动作。

errorpolicy

（关键字）控制出现错误时的行为（参见第 28 页上的第 2.6 节 “异常处理”）。

flush

（关键字；仅用于 PDF_begin_document_callback( )）设置刷新策略。默认值：page。

none 只在文档结尾刷新一次

page 在每页的结尾刷新一次

content 在所有字体、图像、文件附件和页面后进行刷新

heavy 始终在内部 64 KB 文档缓冲区已满时刷新

groups

（字符串列表）定义文档中使用的页面组的名称和顺序。页面组使页面保持在一起（例如，对附加

页标签很有用）；可以将页面指定到文档中定义的一个页面组，并在各自的组内引用。如果为文档

定义了页面组，必须将所有页指定到一个页面组。

hypertext-

encoding

（关键字）指定 destname 选项的编码方式（参见 PDFlib 教程）。空字符串相当于 unicode。默认值：

全局 hypertextencoding 参数的值。

第 2 章：常规函数

inmemory

（布尔型；不能用于 PDF_begin_document_callback( )）如果为 true 且 linearize 或 optimize 选项也

为 true， PDFlib 不会为线性化处理创建任何临时文件，文件的处理将在内存中进行。这可能会大大

提高某些系统上的性能（尤其是 MVS），但要求两倍于文档大小的内存。如果为 false，将为线性化

和优化处理创建临时文件。默认值：false

labels

（选项列表的列表）包含根据表 2.4

提供的一个或多个选项列表的列表，指定符号页面名称。页面名

称将在 Acrobat 的状态行中显示为页面标签（而非页码）。在一个文档中， style/prefix/start 值

的组合必须是唯一的。默认值：none

lang

（字符串；如果 tagged=true，则要求此选项）将文档的自然语言设为由两个字符组成的 ISO 639 语

言代码（例如：DE、 EN、 FR、 JA），后面可以跟一个连字符和由两个字符组成的 ISO 3166 国家 / 地

区代码（例如：EN-US、 EN-GB、 ES-MX）。不区分大小写。

在初始化时，需为文档的语言规范统一赋值，随后可在结构树的各个级别上用新值覆盖。

linearize

（布尔型；不能用于 PDF_begin_document_callback( )）如果为 true，将对输出文档进行线性化处理。

在 MVS 系统上，此选项不能用于将生成的 PDF 输出到内存（即，空 filename）。默认值：false

master-

password

（字符串；不能用于 PDF/A 和 PDF/X）文档的许可口令。如果此选项为空，将不应用许可口令。

默认值：empty

metadata

（选项列表； PDF 1.4）提供文档的元数据（参见第 144 页上的第 12.2 节“XMP 元数据 ”）。

moddate

（布尔型）如果为 true，将创建 ModDate （修改日期）文档信息关键字，以符合某些 preflight 工具

的要求。默认值：false

openmode

（关键字）设置文档打开时的外观。默认值：如果文档包含任何书签，则为 bookmarks ；

否则为 none。

none 打开时不显示任何其他面板。

bookmarks 打开时显示书签面板。

thumbnails 打开时显示缩览图面板。

fullscreen 以全屏模式打开（不适用于浏览器）。

layers (PDF 1.5) 打开时显示图层面板。

attachments (PDF 1.6) 打开时显示附件面板。

optimize

（布尔型）如果为 true，将在生成输出文档后单独对输出文档进行优化处理。优化处理将通过消除

多余的重复对象来减小文件大小。在 MVS 系统上，此选项不能用于将生成的 PDF 输出到内存（即，

空 filename）。默认值：false

pagelayout

（关键字）打开文档时使用的页面版面。默认值：默认值。

default Acrobat 浏览器的缺省设置。

singlepage 一次显示一页。

onecolumn 在一列中连续显示多页。

twocolumnleft 在两列中显示多页，奇数页在左侧。

twocolumnright 在两列中显示多页，奇数页在右侧。

twopageleft (PDF 1.5) 一次显示两页，奇数页在左侧。

twopageright (PDF 1.5) 一次显示两页，奇数页在右侧。

pdfa

（关键字）设置 PDF/A 规范等级，例如 PDF/A-1a:2005、 PDF/A-1b:2005 或 none。如果值为

“PDF/A-1a:2005”，将自动启用标签 PDF 模式。默认值：none

pdfx

（关键字）设置 PDF/X 规范等级，例如 PDF/X-1a:2001、 PDF/X-1a:2003、 PDF/X-2:2003、

PDF/X-3:2002、 PDF/X-3:2003 或 none。默认值：none

表 2.3 PDF_begin_document( ) 和 PDF_end_document( ) 的文档选项（续）

选项描述

2.3 文档函数

permissions

（关键字列表；不能用于 PDF/A 和 PDF/X）输出文档的访问权限列表。它包含任意数目的下列关键字

（默认值：空）。

noprint Acrobat 将阻止打印文件。

nomodify Acrobat 将阻止用户进行除 noannots、noforms 和 noassemble 所允许之外的任

何其他更改。

nocopy Acrobat 将阻止复制或提取文本或图形；辅助工具接口将由 noaccessible 控制。

noannots Acrobat 将阻止添加或更改注释、填充表单域以及添加或更改表单域。

noforms (PDF 1.4) Acrobat 将阻止填充表单域。

noaccessible

(PDF 1.4) Acrobat 将阻止提取文本或图形，以限制辅助工具（如读屏器程序）。

noassemble

(PDF 1.4) Acrobat 将阻止插入、删除或旋转页面和创建书签和缩览图。

nohiresprint

(PDF 1.4) 如果没有设置 noprint，则只能使用 “打印为图像”功能；这将打印

以低分辨率呈现的页面。

plainmetadata (PDF 1.5) 保持 XMP 文档元数据不加密；即使加密文档，也是如此。

recordsize

（整型；仅用于 MVS）输出文件（以及为 linearize 和 optimize 选项所创建的必要的临时文件）的

记录大小。默认值：0 （无阻断输出）

（选项列表）指示 Acrobat 在打开文档时附加搜索索引。支持下列子选项：

filename （名称字符串；是必需的）包含搜索索引的文件名。索引的文件名可能是相对文档的，

不过用户应负责提供正确的索引文件名。

indextype （名称字符串）索引的类型；对于 Acrobat，必须为 PDX。默认值：PDX

tagged

（布尔型； PDF 1.4）如果为 true，则生成加标签的 PDF 输出。必须由客户端在加标签的 PDF 模式

下，提供正确的结构信息（参见第 146 页上的第 12.3 节“标签 PDF”）。如果 pdfa 选项的值为

“PDF/A-1a:2005”，此选项将自动强制为 true。默认值：false

tempdirname

（字符串；不能用于 PDF_begin_document_callback( )）将在其中创建 linearize 和 optimize 选项所

需临时文件的目录的名称。如果为空， PDFlib 将在当前目录内生成临时文件。如果提供了

tempfilenames

选项，则将忽略此选项。

默认值：empty

temp-

filenames

（两个字符串的列表；仅在 MVS 上用于 PDF_begin_document( )） linearize 和 optimize 选项所需的

两个临时文件的完整文件名。如果为空， PDFlib 将生成唯一的临时文件名。用户负责在 PDF_end_

document( ) 之后删除临时文件。如果提供了此选项， filename 参数不能为空。默认值：empty

uri

（字符串）设置文档的基本 URL。将具有指向其他文档的相对 Web 链接的文档移至不同位置时，

此选项非常有用。设置到 »old« 位置的基本 URL 可确保相对链接仍然可以使用。默认值：none

user-

password

（字符串；不能用于 PDF/A 和 PDF/X）文档的打开口令。如果为空，则不应用文档打开口令。

默认值：empty

viewer-

preferences

（选项列表）选项列表，根据表 2.5 指定各种查看器首选项。默认值：empty

1. 仅用于 PDF_end_document( )

2. 仅用于

PDF_begin_document( ) 和 PDF_begin_document_callback( )

表 2.3 PDF_begin_document( ) 和 PDF_end_document( ) 的文档选项（续）

选项描述

第 2 章：常规函数

表 2.4 PDF_begin/end_document( ) 中 labels 选项和 PDF_begin/end_page_ext( ) 中 label 选项的子选项

选项描述

group

（字符串；仅用于 PDF_begin_document( ) ；如果文档使用页面组，则要求此选项；否则，不允许

使用此选项）标签将应用于指定组以及应用新标签之前的所有后续组中的所有页面。必须已经用

PDF_begin_document( ) 中的 groups 选项定义了组名。

hypertexten-

coding

（关键字）指定 prefix 选项的编码方式。空字符串相当于 unicode。默认值：全局

hypertextencoding 参数的值。

pagenumber

（整型；仅用于 PDF_end_document( ) ；如果文档不使用页面组，则要求此选项，否则不允许使用此

选项）标签将应用于指定页面以及应用新标签之前的所有页面。

前缀（超文本字符串）处于该范围内的所有标签的标签前缀。默认值：none

start

（整型 >= 1）该范围内第一个标签的数值。该范围内的后续页面将从该值开始，依次编号。默认值：1

style

（关键字）要使用的编号样式。默认值：none。

none 无页码；标签将只包含前缀。

D 十进制阿拉伯数字（1、 2、 3、 ...）

R 大写罗马数字（I、 II、 III、 ...）

r 小写罗马数字（i、 ii、 iii、 ...)

A 大写字母（A、 B、 C、 ...、 AA、 BB、 CC、 ...)

a 小写字母（a、 b、 c、 ...、 aa、 bb、 cc、 ...)

表 2.5 PDF_begin_document( ) 和 PDF_end_document( ) 中 viewerpreferences 选项的子选项

选项描述

centerwindow

（布尔型）指定是否将文档窗口置于屏幕中央。默认值：false

direction

（关键字）阅读文档的顺序，将影响双页面视图中的滚动顺序。（缺省为 l2r）：

l2r 从左至右

r2l 从右至左（包括直排书写系统）

displaydoctitle

（布尔型）指定是否在 Acrobat 的标题栏 (true) 或是文件名 (false) 中显示 Title 文档信息域。

默认值：false

fitwindow

（布尔型）指定是否将文档窗口的大小调整为第一页的大小。默认值：false

hidemenubar

（布尔型）指定是否隐藏 Acrobat 菜单栏。默认值：false

hidetoolbar

（布尔型）指定是否隐藏 Acrobat 工具栏。在浏览器中查看 PDF 时， Acrobat 5 会忽略此设置。

默认值：false

hidewindowui

（布尔型）指定是否隐藏 Acrobat 的窗口控件。默认值：false

nonfullscreenp

agemode

（关键字；仅用于 openmode 选项设为 fullscreen 的情况）指定如何在现有全屏模式下显示文档。

默认值：none。

bookmarks 显示页面和书签窗格

thumbnails 显示页面和缩览图窗格

layers 显示页面和图层窗格

none 只显示页面

printscaling

（关键字； PDF 1.6）打开文档的打印对话框时将选择的页面缩放选项。默认值：appdefault.

none 无页面缩放；这对于按页面内容的实际大小打印很有帮助。

appdefault

使用 Acrobat 中指定的当前打印缩放。

viewarea

viewclip

printarea

printclip

（关键字）在屏幕上查看或打印文档时，代表要显示或剪贴的页面区域的页面边界框类型。 Acrobat

会忽略此设置，但可能对其他应用程序很有用。默认值：crop。

art 使用作品框

bleed 使用出血框

crop 使用裁剪框

media 使用媒体框

trim 使用裁切框

剩余166页未读，继续阅读

一光年的梦

粉丝: 16
资源: 4

PDFlib 7.0.1 控件使用手册：C++、Java、PHP等多语言支持

PDFlib开发手册（中文版）

PDFlib

调用PDFlib导入pdf书签文件(src)

PDFlib-API-reference-CS中文版

PDFlib-API-reference-..-中文手册[精选PDF].xdf

PDFLib-lite-7.0.5

PDFlib-0.6

PDFlib-8.0.6-MSWin32-C-C++

PDFlib-CMap-4.0.zip

PDFlib-7.0.3-Linux for VB

最新资源