Foxit PDF SDK

静态 Public 成员函数 | 所有成员列表
FSDK::Office2PDF类 参考

## 静态 Public 成员函数
static | ConvertFromExcel (src_excel_file_path, src_file_password, saved_pdf_path, setting_data)
| 将 Excel 格式文件转换为 PDF 文件。 更多...
static | ConvertFromExcel (src_excel_reader, src_file_password, saved_pdf_file_stream, setting_data)
| 将 Excel 格式文件转换为 PDF 文件。 更多...
static | ConvertFromPowerPoint (src_ppt_file_path, src_file_password, saved_pdf_path, setting_data)
| 将 PowerPoint 格式文件转换为 PDF 文件。 更多...
static | ConvertFromPowerPoint (src_ppt_reader, src_file_password, saved_pdf_file_stream, setting_data)
| 将 PowerPoint 格式文件转换为 PDF 文件。 更多...
static | ConvertFromWord (src_word_file_path, src_file_password, saved_pdf_path, setting_data)
| 将 Word 格式文件转换为 PDF 文件。 更多...
static | ConvertFromWord (src_word_reader, src_file_password, saved_pdf_file_stream, setting_data)
| 将 Word 格式文件转换为 PDF 文件。 更多...
static | GetVersion ()
| 获取 Foxit PDF Conversion SDK 的版本。 更多...
static | Initialize (library_path)
| 初始化 Foxit PDF Conversion。 更多...
static | Release ()
| 释放 Foxit PDF Conversion 分配的所有资源。 更多...

## 详细描述

此类可用于将 Office（Word、Excel 或 PowerPoint）格式文件转换为 PDF 文件。 此功能是 Foxit 自主开发的产品，不依赖其他工具。 在使用"转换"模块之前，请确保 Foxit PDF Conversion SDK 包中名为"res"和"lib"的资源文件夹有效。 在使用此模块中的方法之前，请确保 Foxit PDF SDK 已通过函数 FSDK.Library.Initialize 使用包含"Office2PDF"模块的密钥成功初始化。

参见
  FSDK.Library

## 成员函数说明

## ◆ ConvertFromExcel() [1/2]

static FSDK::Office2PDF::ConvertFromExcel | ( | src_excel_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data |
| ) |  |
| static

将 Excel 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 XLSX 格式文件进行转换。

参数

  [in] | src_excel_file_path | Excel 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 Excel 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ ConvertFromExcel() [2/2]

static FSDK::Office2PDF::ConvertFromExcel | ( | src_excel_reader | ,
|  | src_file_password | ,
|  | saved_pdf_file_stream | ,
|  | setting_data |
| ) |  |
| static

将 Excel 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 XLSX 格式文件进行转换。 文件一次性读取，而不是逐步读取。

参数

  [in] | src_excel_reader | 由用户实现的 ReaderCallback 对象， 用于加载 excel 文档。它不应该是 NULL。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 Excel 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 FSDK.StreamCallback 对象， 用于读取转换后的 PDF 文件的内容。它不应该是 NULL。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ ConvertFromPowerPoint() [1/2]

static FSDK::Office2PDF::ConvertFromPowerPoint | ( | src_ppt_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data |
| ) |  |
| static

将 PowerPoint 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 PPTX 格式文件进行转换。

参数

  [in] | src_ppt_file_path | PowerPoint 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 PowerPoint 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ ConvertFromPowerPoint() [2/2]

static FSDK::Office2PDF::ConvertFromPowerPoint | ( | src_ppt_reader | ,
|  | src_file_password | ,
|  | saved_pdf_file_stream | ,
|  | setting_data |
| ) |  |
| static

将 PowerPoint 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 PPTX 格式文件进行转换。 文件一次性读取，而不是逐步读取。

参数

  [in] | src_ppt_reader | 由用户实现的 FSDK.ReaderCallback 对象， 用于加载 PowerPoint 文档。它不应该是 NULL。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 PowerPoint 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 FSDK.StreamCallback 对象， 用于读取转换后的 PDF 文件的内容。它不应该是 NULL。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ ConvertFromWord() [1/2]

static FSDK::Office2PDF::ConvertFromWord | ( | src_word_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data |
| ) |  |
| static

将 Word 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 DOCX/DOC 格式文件进行转换。

参数

  [in] | src_word_file_path | Word 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 Word 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ ConvertFromWord() [2/2]

static FSDK::Office2PDF::ConvertFromWord | ( | src_word_reader | ,
|  | src_file_password | ,
|  | saved_pdf_file_stream | ,
|  | setting_data |
| ) |  |
| static

将 Word 格式文件转换为 PDF 文件。

目前，此函数仅适用于 Windows 和 Linux (32位 和 64 位)，并且仅支持从 DOCX/DOC 格式文件进行转换。 文件一次性读取，而不是逐步读取。

参数

  [in] | src_word_reader | 由用户实现的 FSDK.ReaderCallback 对象， 用于加载 word 文档。它不应该是 NULL。
  [in] | src_file_password | （保留，尚不支持加密文件）输入 Word 格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 FSDK.StreamCallback 对象， 用于读取转换后的 PDF 文件的内容。它不应该是 NULL。
  [in] | setting_data | 用于转换的 FSDK.Office2PDFSettingData 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ GetVersion()

static FSDK::Office2PDF::GetVersion | ( |  | ) |
| static

获取 Foxit PDF Conversion SDK 的版本。

此函数应在函数 FSDK.Office2PDF.Initialize 成功调用后调用。

返回
  包含 Foxit PDF Conversion SDK 版本信息的字符串。

## ◆ Initialize()

static FSDK::Office2PDF::Initialize | ( | library_path |  | ) |
| static

初始化 Foxit PDF Conversion。

在"Office2PDF"模块的生命周期内，此函数只能调用一次， 并且应在"Office2PDF"模块中的任何其他函数之前首先调用。

参数

  [in] | library_path | Foxit PDF Conversion SDK 库的路径。这不应该是空字符串。

返回
  无。

注解
  如果在函数 FSDK.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户没有使用 Office2PDF 相关函数的权限， 此函数将抛出异常 FSDK.e_ErrNoOffice2PDFModuleRight。

## ◆ Release()

static FSDK::Office2PDF::Release | ( |  | ) |
| static

释放 Foxit PDF Conversion 分配的所有资源。

当用户不再使用"Office2PDF"模块时，应调用此函数以释放库分配的所有内存块。

返回
  无。