Foxit PDF SDK

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

## 静态 Public 成员函数
static | FromDWG (engine_pat, src_dwg_path, saved_pdf_path, settings)
| 将 DWG 格式文件转换为 PDF 文件。 更多...
static | FromExcel (src_excel_file_path, src_file_password, saved_pdf_path, setting_data, engine)
| 将 Excel 格式文件转换为 PDF 文件。 更多...
static | FromExcel (src_excel_file_path, src_file_password, saved_pdf_path, engine_path, setting_data, office_to_pdf_engine_path, office_profile_path)
| 将 Excel 格式文件转换为 PDF 文件。 更多...
static | FromHTML (src_html, engine_path, cookies_path, setting_data, saved_pdf_path, timeout)
| 将 HTML 格式文件或网页的 URL 转换为 PDF 文件。 更多...
static | FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_path, timeout)
| 将 HTML 格式文件或网页的 URL 转换为 PDF 文件。 更多...
static | FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
| 将 HTML 格式文件或网页的 URL 转换为 PDF 文件。 更多...
static | FromHTML (src_html, html2pdf_related_resource_array, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
| 将 HTML 格式文件或网页的 URL 转换为 PDF 文件。 更多...
static | FromImage (src_img, saved_pdf_path)
| 将图像格式文件转换为 PDF 文件。 更多...
static | FromImage (file_reader, saved_pdf_filestream)
| 将图像格式文件转换为 PDF 文件。 更多...
static | FromOFD (src_ofd_path, password, saved_pdf_file_path, OFDConvertParam)
| 将 OFD 文件转换为 PDF 文件。 更多...
static | FromPowerPoint (src_ppt_file_path, src_file_password, saved_pdf_path, setting_data, engine)
| 将 PowerPoint 格式文件转换为 PDF 文件。 更多...
static | FromPowerPoint (src_ppt_file_path, src_file_password, saved_pdf_path, engine_path, setting_data, office_to_pdf_engine_path, office_profile_path)
| 将 PowerPoint 格式文件转换为 PDF 文件。 更多...
static | FromTXT (src_txt, saved_pdf_path, setting_data)
| 将 TXT 格式文件转换为 PDF 文件。 更多...
static | FromWord (src_word_file_path, src_file_password, saved_pdf_path, setting_data, engine)
| 将 Word 格式文件转换为 PDF 文件。 更多...
static | FromWord (src_word_file_path, src_file_password, saved_pdf_path, engine_path, setting_data, office_to_pdf_engine_path, office_profile_path)
| 将 Word 格式文件转换为 PDF 文件。 更多...
static | ToOFD (src_pdf_path, password, saved_ofd_file_path, convert_param)
| 将 PDF 文件转换为 OFD 文件。 更多...
static | ToXML (src_pdf_path, src_file_password, saved_xml_path, saved_image_folder_path, is_force_to_tagged_pdf)
| 将 PDF 文件转换为 XML 格式文件。 更多...

## Public 属性
| e_Office2PdfEngineMicrosoft
| 用于 Windows 平台 Office 转 PDF 的转换引擎类型枚举。 更多...
| e_Office2PdfEngineWps
| WPS Office 自动化引擎。

## 详细描述

转换附加模块可用于在 PDF 文件和其他文件格式之间进行一些转换。 在使用“转换”模块之前，用户应首先准备字体资源文件夹，如“Foxit PDF SDK Developer Guide.pdf”文档中所述。 在使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK 已通过函数 FSDK.Library.Initialize 使用包含“转换”模块的密钥成功初始化。 在使用函数 FSDK.Convert.FromDWG 之前，请确保 Foxit PDF SDK 已通过函数 FSDK.Library.Initialize 使用包含“DWG2PDF”模块的密钥成功初始化。

参见
  FSDK.Library

## 成员函数说明

## ◆ FromDWG()

static FSDK::Convert::FromDWG | ( | engine_pat | ,
|  | src_dwg_path | ,
|  | saved_pdf_path | ,
|  | settings |
| ) |  |
| static

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

目前，此函数仅可用于桌面平台；对于其他平台，此函数将直接返回 false 而不执行任何操作。

参数

  [in] | engine_path | "DWG 到 PDF"引擎的目录路径。这不应该是空字符串。
  [in] | src_dwg_path | DWG 或 DXF 格式文件路径。这不应该是空字符串。
  [in] | saved_pdf_path | 用于保存转换后的 PDF 文件的路径。这不应该是空字符串。
  [in] | settings | 用于转换的 FSDK.DWG2PDFSettingData 对象。

返回
  无。

## ◆ FromExcel() [1/2]

static FSDK::Convert::FromExcel | ( | src_excel_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data | ,
|  | engine |
| ) |  |
| static

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

目前，此函数仅可用于 Windows。

参数

  [in] | src_excel_file_path | Excel 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Excel 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的设置数据。
  [in] | engine | 使用的转换引擎。请参考从 FSDK.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：FSDK.Convert.e_Office2PdfEngineMicrosoft。

返回
  无。

## ◆ FromExcel() [2/2]

static FSDK::Convert::FromExcel | ( | src_excel_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | engine_path | ,
|  | setting_data | ,
|  | office_to_pdf_engine_path | ,
|  | office_profile_path |
| ) |  |
| static

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

目前，此函数可用于 Linux armv8 或 Linux x86/x86_64系统。 如果您在 Linux armv8 系统上，请确保机器上安装了 WPS 专业版。 如果您在 Linux x86/x86_64系统上，请确保机器上安装了 LibreOffice。

参数

  [in] | src_excel_file_path | Excel 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Excel 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | engine_path | 在 Linux armv8 系统中，用于表示 WPS 引擎（librpcetapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。 它可以是空的。默认路径："/opt/kingsoft/wps-office/office6"。 在 Linux x86/x86_64系统中，用于表示 LibreOffice 引擎（soffice.bin）的路径，并且不能为空。 例如，"/usr/lib/libreoffice/program"。
  [in] | setting_data | （保留，尚不支持）用于转换的设置数据。
  [in] | office_to_pdf_engine_path | "Office 到 PDF"引擎的路径。此参数仅适用于 Linux x86/x86_64系统。 它可以是空的。如果参数为空，将直接调用 LibreOffice 引擎进行 Excel 到 PDF 的转换， 否则将通过"Office 到 PDF"引擎调用 LibreOffice 引擎进行 Excel 到 PDF 的转换。
  [in] | office_profile_path | 用户定义的目录路径，用于存储 LibreOffice 引擎的用户配置文件。它需要与"Office 到 PDF"引擎一起使用。 它可以是空的。如果参数为空，LibreOffice 引擎将使用默认用户配置文件且不支持多线程， 否则 LibreOffice 引擎将在用户定义的目录中创建新的用户配置文件以支持多线程。

返回
  无。

## ◆ FromHTML() [1/4]

static FSDK::Convert::FromHTML | ( | src_html | ,
|  | engine_path | ,
|  | cookies_path | ,
|  | setting_data | ,
|  | saved_pdf_path | ,
|  | timeout |
| ) |  |
| static

将 HTML 格式文件或网页的 URL 转换为 PDF 文件。

目前，此函数仅可用于桌面平台；对于其他平台，此函数将直接返回而不执行任何操作。

参数

  [in] | src_html | 网页的 URL 或 HTML 格式文件路径。这不应该是空字符串。
  [in] | engine_path | “HTML 到 PDF”引擎的目录路径。这不应该是空字符串。
  [in] | cookies_path | cookies 文件的路径。如果这是空字符串，则表示不使用 cookie 文件。 强烈建议数据格式使用 JSON 格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_path | 用于保存转换后的 PDF 文件的路径。这不应该是空字符串。
  [in] | timeout | 用于加载网页的超时秒数。应设置为大于 15 的值。 如果这小于 15，则默认使用 15。

返回
  无。

## ◆ FromHTML() [2/4]

static FSDK::Convert::FromHTML | ( | src_html | ,
|  | engine_path | ,
|  | cookies_reader | ,
|  | setting_data | ,
|  | saved_pdf_path | ,
|  | timeout |
| ) |  |
| static

将 HTML 格式文件或网页的 URL 转换为 PDF 文件。

目前，此函数仅可用于桌面平台；对于其他平台，此函数将直接返回而不执行任何操作。

参数

  [in] | src_html | 网页的 URL 或 HTML 格式文件路径。这不应该是空字符串。
  [in] | engine_path | “HTML 到 PDF”引擎的目录路径。这不应该是空字符串。
  [in] | cookies_reader | 由用户实现的 FSDK.FileReaderCallback 对象， 用于将 cookies 数据传递给 Foxit PDF SDK。如果这是 null，则表示不使用 cookie 数据。 强烈建议数据格式使用 JSON 格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_path | 用于保存转换后的 PDF 文件的路径。这不应该是空字符串。
  [in] | timeout | 用于加载网页的超时秒数。应设置为大于 15 的值。 如果这小于 15，则默认使用 15。

返回
  无。

## ◆ FromHTML() [3/4]

static FSDK::Convert::FromHTML | ( | src_html | ,
|  | engine_path | ,
|  | cookies_reader | ,
|  | setting_data | ,
|  | saved_pdf_filestream | ,
|  | timeout |
| ) |  |
| static

将 HTML 格式文件或网页的 URL 转换为 PDF 文件。

目前，此函数仅可用于桌面平台；对于其他平台，此函数将直接返回而不执行任何操作。

参数

  [in] | src_html | 网页的 URL 或 HTML 格式文件路径。这不应该是空字符串。
  [in] | engine_path | “HTML 到 PDF”引擎的目录路径。这不应该是空字符串。
  [in] | cookies_reader | 由用户实现的 FSDK.FileReaderCallback 对象， 用于将 cookies 数据传递给 Foxit PDF SDK。如果这是 null，则表示不使用 cookie 数据。 强烈建议数据格式使用 JSON 格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_filestream | 用于保存转换后的 PDF 文件的 FSDK.FileWriterCallback 对象。这不应该是 null。
  [in] | timeout | 用于加载网页的超时秒数。应设置为大于 15 的值。 如果这小于 15，则默认使用 15。

返回
  无。

## ◆ FromHTML() [4/4]

static FSDK::Convert::FromHTML | ( | src_html | ,
|  | html2pdf_related_resource_array | ,
|  | engine_path | ,
|  | cookies_reader | ,
|  | setting_data | ,
|  | saved_pdf_filestream | ,
|  | timeout |
| ) |  |
| static

将 HTML 格式文件或网页的 URL 转换为 PDF 文件。

目前，此函数仅可用于桌面平台和 Mac ARM 平台；对于其他平台，此函数将直接返回而不执行任何操作。

参数

  [in] | src_html | 由用户实现的 FSDK.FileReaderCallback 对象， 用于将 HTML 数据传递给 Foxit PDF SDK。它必须是有效的。
  [in] | html2pdf_related_resource_array | 与源 HTML 相关的 FSDK.HTML2PDFRelatedResourceArray。
  [in] | engine_path | “HTML 到 PDF”引擎的目录路径。这不应该是空字符串。
  [in] | cookies_reader | (保留；尚不支持)由用户实现的 FSDK.FileReaderCallback 对象， 用于将 cookies 数据传递给 Foxit PDF SDK。如果这是 null，则表示不使用 cookie 数据。 强烈建议数据格式使用 JSON 格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_filestream | 用于保存转换后的 PDF 文件的 FSDK.FileWriterCallback 对象。这不应该是 null。
  [in] | timeout | 用于加载网页的超时秒数。应设置为大于 15 的值。 如果这小于 15，则默认使用 15。

返回
  无。

## ◆ FromImage() [1/2]

static FSDK::Convert::FromImage | ( | src_img | ,
|  | saved_pdf_path |
| ) |  |
| static

将图像格式文件转换为 PDF 文件。

参数

  [in] | src_img | 图像格式文件路径。这不应该是空字符串。
  [in] | saved_pdf_path | 用于保存转换后的 PDF 文件的路径。这不应该是空字符串。

返回
  无。

## ◆ FromImage() [2/2]

static FSDK::Convert::FromImage | ( | file_reader | ,
|  | saved_pdf_filestream |
| ) |  |
| static

将图像格式文件转换为 PDF 文件。

参数

  [in] | file_reader | 由用户实现的 FSDK.FileReaderCallback 对象， 用于将图像数据传递给 Foxit PDF SDK。它必须是有效的。
  [in] | saved_pdf_filestream | 用于保存转换后的 PDF 文件的 FSDK.FileWriterCallback 对象。 这不应该是 null。

返回
  无。

## ◆ FromOFD()

static FSDK::Convert::FromOFD | ( | src_ofd_path | ,
|  | password | ,
|  | saved_pdf_file_path | ,
|  | OFDConvertParam |
| ) |  |
| static

将 OFD 文件转换为 PDF 文件。

请确保在使用此函数之前已成功调用 FSDK.Library.InitializeOFDEngine。

参数

  [in] | src_ofd_path | 现有 OFD 文件的完整路径。它不应该是空字符串。
  [in] | password | OFD 文件的密码。如果 OFD 文件未加密，则应该是空字符串。
  [in] | saved_pdf_file_path | 转换后的 PDF 文件的完整路径。它不应该是空字符串。
  [in] | convert_param | 转换参数对象。

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

## ◆ FromPowerPoint() [1/2]

static FSDK::Convert::FromPowerPoint | ( | src_ppt_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data | ,
|  | engine |
| ) |  |
| static

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

目前，此函数仅可用于 Windows。

参数

  [in] | src_ppt_file_path | PowerPoint 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Excel 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的设置数据。
  [in] | engine | 使用的转换引擎。请参考从 FSDK.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：FSDK.Convert.e_Office2PdfEngineMicrosoft。

返回
  无。

## ◆ FromPowerPoint() [2/2]

static FSDK::Convert::FromPowerPoint | ( | src_ppt_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | engine_path | ,
|  | setting_data | ,
|  | office_to_pdf_engine_path | ,
|  | office_profile_path |
| ) |  |
| static

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

目前，此函数可用于 Linux armv8 或 Linux x86/x86_64系统。 如果您在 Linux armv8 系统上，请确保机器上安装了 WPS 专业版。 如果您在 Linux x86/x86_64系统上，请确保机器上安装了 LibreOffice。

参数

  [in] | src_ppt_file_path | PowerPoint 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Excel 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | engine_path | 在 Linux armv8 系统中，用于表示 WPS 引擎（librpcwppapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。 它可以是空的。默认路径："/opt/kingsoft/wps-office/office6"。 在 Linux x86/x86_64系统中，用于表示 LibreOffice 引擎（soffice.bin）的路径，并且不能为空。 例如，"/usr/lib/libreoffice/program"。
  [in] | setting_data | （保留，尚不支持）用于转换的设置数据。
  [in] | office_to_pdf_engine_path | "Office 到 PDF"引擎的路径。此参数仅适用于 Linux x86/x86_64系统。 它可以是空的。如果参数为空，将直接调用 LibreOffice 引擎进行 PowerPoint 到 PDF 的转换， 否则将通过"Office 到 PDF"引擎调用 LibreOffice 引擎进行 PowerPoint 到 PDF 的转换。
  [in] | office_profile_path | 用户定义的目录路径，用于存储 LibreOffice 引擎的用户配置文件。它需要与"Office 到 PDF"引擎一起使用。 它可以是空的。如果参数为空，LibreOffice 引擎将使用默认用户配置文件且不支持多线程， 否则 LibreOffice 引擎将在用户定义的目录中创建新的用户配置文件以支持多线程。

返回
  无。

## ◆ FromTXT()

static FSDK::Convert::FromTXT | ( | src_txt | ,
|  | saved_pdf_path | ,
|  | setting_data |
| ) |  |
| static

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

参数

  [in] | src_txt | TXT 格式文件路径。这不应该是空字符串。
  [in] | saved_pdf_path | 用于保存转换后的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的设置数据。

返回
  无。

## ◆ FromWord() [1/2]

static FSDK::Convert::FromWord | ( | src_word_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | setting_data | ,
|  | engine |
| ) |  |
| static

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

目前，此函数仅可用于 Windows。

参数

  [in] | src_word_file_path | Word 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Word 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | setting_data | 用于转换的设置数据。
  [in] | engine | 使用的转换引擎。请参考从 FSDK.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：FSDK.Convert.e_Office2PdfEngineMicrosoft。

返回
  无。

## ◆ FromWord() [2/2]

static FSDK::Convert::FromWord | ( | src_word_file_path | ,
|  | src_file_password | ,
|  | saved_pdf_path | ,
|  | engine_path | ,
|  | setting_data | ,
|  | office_to_pdf_engine_path | ,
|  | office_profile_path |
| ) |  |
| static

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

目前，此函数可用于 Linux armv8 或 Linux x86/x86_64系统。 如果您在 Linux armv8 系统上，请确保机器上安装了 WPS 专业版。 如果您在 Linux x86/x86_64系统上，请确保机器上安装了 LibreOffice。

参数

  [in] | src_word_file_path | Word 格式文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 Word 格式文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的 PDF 文件的路径。这不应该是空字符串。
  [in] | engine_path | 在 Linux armv8 系统中，用于表示 WPS 引擎（librpcwpsapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。 它可以是空的。默认路径："/opt/kingsoft/wps-office/office6"。 在 Linux x86/x86_64系统中，用于表示 LibreOffice 引擎（soffice.bin）的路径，并且不能为空。 例如，"/usr/lib/libreoffice/program"。
  [in] | setting_data | （保留，尚不支持）用于转换的设置数据。
  [in] | office_to_pdf_engine_path | "Office 到 PDF"引擎的路径。此参数仅适用于 Linux x86/x86_64系统。 它可以是空的。如果参数为空，将直接调用 LibreOffice 引擎进行 Word 到 PDF 的转换， 否则将通过"Office 到 PDF"引擎调用 LibreOffice 引擎进行 Word 到 PDF 的转换。
  [in] | office_profile_path | 用户定义的目录路径，用于存储 LibreOffice 引擎的用户配置文件。它需要与"Office 到 PDF"引擎一起使用。 它可以是空的。如果参数为空，LibreOffice 引擎将使用默认用户配置文件且不支持多线程， 否则 LibreOffice 引擎将在用户定义的目录中创建新的用户配置文件以支持多线程。

返回
  无。

## ◆ ToOFD()

static FSDK::Convert::ToOFD | ( | src_pdf_path | ,
|  | password | ,
|  | saved_ofd_file_path | ,
|  | convert_param |
| ) |  |
| static

将 PDF 文件转换为 OFD 文件。

请确保在使用此函数之前已成功调用 FSDK.Library.InitializeOFDEngine。

参数

  [in] | src_pdf_path | 现有 PDF 文件的完整路径。它不应该是空字符串。
  [in] | password | PDF 文件的密码。如果 PDF 文件未加密，则应该是空字符串。
  [in] | saved_ofd_file_path | 转换后的 OFD 文件的完整路径。它不应该是空字符串。
  [in] | convert_param | 转换参数对象。

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

## ◆ ToXML()

static FSDK::Convert::ToXML | ( | src_pdf_path | ,
|  | src_file_password | ,
|  | saved_xml_path | ,
|  | saved_image_folder_path | ,
|  | is_force_to_tagged_pdf |
| ) |  |
| static

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

参数

  [in] | src_pdf_path | PDF 文件的路径。这不应该是空字符串。
  [in] | src_file_password | 输入 PDF 文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_xml_path | 作为转换结果保存的 XML 格式文件的路径。这不应该是空字符串。
  [in] | saved_image_folder_path | 用于指定在转换过程中生成图像文件的文件夹的路径。 如果这是空字符串，图像文件将生成到名为"images"的文件夹中（如果不存在， Foxit PDF SDK 将默认生成此类文件夹）。文件夹"images"将与 保存的 XML 格式文件（作为参数 saved_xml_path）位于同一目录中。
  [in] | is_force_to_tagged_pdf | （仅当输入 PDF 文件不是标记 PDF 文件时有用） 布尔值，决定当输入 PDF 文件不是标记 PDF 时是否允许将输入 PDF 文件转换为标记 PDF： true 表示输入 PDF 文件（尚未标记 PDF）将首先转换为标记 PDF。 然后标记 PDF 将转换为 XML 格式文件。 false 表示不允许将输入 PDF 文件（尚未标记 PDF）转换为标记 PDF。 在这种情况下，输入 PDF 文件将不会转换为 XML 格式文件，此函数将返回 false。

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

## 类成员变量说明

## ◆ e_Office2PdfEngineMicrosoft

FSDK::Convert::e_Office2PdfEngineMicrosoft

用于 Windows 平台 Office 转 PDF 的转换引擎类型枚举。

此枚举中的值应单独使用。Microsoft Office 自动化引擎。