福昕开发者文档中心

示例工程 ​

福昕 PDF SDK 所有示例（如下表所示）存放在 examples 文件夹下。不同的平台和语言库支持的示例会有所差异。

Examples描述平台库 / 框架
extensions_demo存放打印管理器示例C++ / .Net
simple_demo提供大量的代码示例，演示 PDF 接口的使用。C++ 示例最为完善。所有 SDK 库
view_demo提供一个 UI 示例，演示如何使用接口实现基础 的 PDF 阅读器C++ / .Net
QT view_demo提供一个基于 QT 框架的 UI 示例，演示如何使用接口实现基础 的 PDF 阅读器Linux C++

examples/simple_demo/input_files 包含了所有示例中需要使用的测试文档。对于有输出文件 (pdf, 文本或者图片文件) 的示例，会在 examples/simple_demo/output_files/ 文件夹下生成以该示例名称命名的文件夹，并且输出文件将会在该文件夹下生成。

示例运行与依赖说明 ​

\examples\simple_demo 目录下大部分示例可直接运行，但部分示例有额外依赖需求，请仔细阅读下表的依赖说明。

示例支持直接运行依赖
office2pdf否福昕转换 SDK 资源包，或福昕专用 pdf2office 资源包
pdf2office否福昕转换 SDK 资源包
LibreOffice2pdf否福昕多线程专用 LibreOffice 资源包
dwg2pdf否dwg2pdf 资源包
html2pdf否html2pdf 资源包
compliance 和 preflight否compliance 资源包
ocr否ocr 资源包
ofd否ofd 资源包
signature部分OpenSSL 源码包
paging_seal_signature部分OpenSSL 源码包
security部分OpenSSL 源码包

提示

  • OpenSSL 源码包： SDK Java 库的示例目录已包含，DotNet 库已内置。使用这两个库的用户无需额外下载。
  • 其他依赖资源包： 您可以从福昕官方开发者站点下载，或直接联系福昕技术支持或销售代表获取。

运行准备 ​

开发环境配置 ​

为了确保您能够顺利编译和运行 SDK 示例工程，请根据您使用的开发语言配置相应的开发环境：

  • 福昕 Linux C/C++, Mac C++ SDK: CMake ≥ 3.1, x86/x64 gcc ≥ 4.94, arm gcc ≥ 8.3
  • 福昕 Java SDK: JDK 版本 ≥ 1.8。
  • 福昕 .NETCore x64 SDK: .NETCore 运行时版本 ≥ 2.1。
  • 福昕 .NET Framework SDK:.NET Framework ≥ 4.0 。
  • 福昕 Python SDK: Python 2.7 或 Python 3.6-3.10
  • 福昕 Node.js SDK: Node.js 版本 8-20

系统要求 ​

关于操作系统版本、编译器要求等，请选择您的操作系统平台，查看详细信息:

运行示例 ​

不同平台的开发语言库，其示例运行方式略有差异。

  • Windows C/C++ 和 .NET 库: 由于 SDK 未直接提供命令行运行程序，如 .bat 或 .sh，可使用 IDE（如 Visual Studio）或特定示例脚本来编译并运行示例工程。
  • SDK 其他开发语言库: 可选择使用 SDK 提供的命令行运行程序、特定示例脚本或 IDE 运行示例。
  • Linux/Mac C++ 库: 还可选择 使用 CMake 和 Make 编译和运行示例。

以下介绍如何通过命令行脚本运行相关示例。关于使用 IDE 运行示例，请参阅各个开发框架或语言库的文档。

Simple demo ​

\examples\simple_demo 目录下的示例，除了有 额外依赖需求的示例 及 Python 示例工程外外，其他有包含命令行运行程序的示例工程，都可以直接运行 .bat 或者 .sh 文件. 关于运行 Python 示例，请查阅 福昕 PDF SDK Python 库。

运行所有示例 ​

  • Windows 平台运行 RunAllDemo.bat all 或 RunAllDemo.bat all x86。
  • Linux 和 Mac 平台运行 RunAllDemo.sh all。

运行某个特定的示例 ​

  • Windows 平台运行 RunDemo.bat demo_name 或 RunDemo.bat demo_name x86。 比如，RunDemo.bat bookmark x86 只运行 bookmark 示例。
  • Linux 和 Mac 平台运行RunDemo.sh demo_name。

Security demo ​

Linux 或 Mac 平台请参阅下文 Signature demo 来运行该示例。 Windows 平台请参阅以下步骤：

在运行 security demo 之前，您需要安装 \examples\simple_demo\input_files 文件夹下的 foxit.cer 和 foxit_all.pfx 证书。

  1. 安装 foxit.cer，双击其启动证书导入向导。然后选择 Install certificate… > Next > Next > Finish。
  2. 安装 foxit_all.pfx，双击其启动证书导入向导。然后选择 Next > Next > (在文本框中输入私钥的密码 "123456") ，然后点击Next > Next > Finish。
  3. 参考上文 simple demo 的运行步骤运行该示例。

Signature demo /paging_seal_signature ​

在运行 signature demo 之前，您需要确保已经安装了 OpenSSL。从OpenSSL 官网下载 OpenSSL 源码包，或者您可以直接与我们客服联系。获取到源码包后，解压并进行如下操作:

Windows ​

  1. 将 OpenSSL 文件夹拷贝到 include 文件夹下，以确保示例中引用的 OpenSSL 头文件可以被识别到。
  2. 将 libeay32.lib 库拷贝到 lib 文件夹下。
  3. 参考其他 simple demo 的运行步骤运行该示例。

Linux / Mac ​

  1. 将OpenSSL文件夹拷贝到 include 文件夹下，以确保示例中引用的 OpenSSL 头文件可以被识别到。
  2. 将 libssl.a 和 libcrypto.a 库拷贝到 lib 文件夹下。
  3. 参考上文 simple demo 的运行步骤运行该示例。

提示

  • OpenSSL 1.1.1-stable 版本在 signature 示例中已经验证是可用的。您可以替换为其他所需的版本，但可能需要做一些相应的更改。
  • Python Linux/Mac 平台开发者在运行 Security，signature 和 paging_seal_signature 示例之前，您需要确保已经安装了cryptography 和 pyopenssl。详细参考Python 的相关说明。

OCR demo ​

  • 支持 Windows 和 Linux x64
  • 运行 ocr demo 前，您需要首先构建一个资源目录，下载资源包，再把相关资源放到这个目录下。关于如何运行该示例的更详细的信息，请参考 OCR 示例配置及运行指南。

Compliance 和 Preflight demo ​

  • 支持 Windows， Linux x86/x64 和 Mac
  • 运行 compliance demo 前，您需要首先构建一个资源目录，下载资源包，再把相关资源放到这个目录下。关于如何运行该示例的更详细的信息，请参考 PDF 合规性示例配置与运行指南。

HTML to PDF demo ​

Output Preview demo ​

  • 支持 Windows, Linux x86/x64 和 Mac x64
  • 运行 output preview demo 前，您需要设置包含默认 icc profile 文件的文件夹路径。关于如何运行该示例的更详细信息，请参考 输出预览示例配置与运行指南。

Office to PDF demo (依赖第三方引擎) ​

Office to PDF demo (福昕自研转换引擎) ​

PDF to Office demo（福昕自研转换引擎） ​

Dwg to PDF demo ​

  • 支持 Windows, Linux x86/x64 和 Mac x64
  • 运行 dwg2pdf demo 前，您需要先下载资源包。关于如何运行该示例的更详细的信息，请参考 DWG 转 PDF 示例配置与运行指南。

OFD demo ​

  • Windows 和 Linux x64/armv8