Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.addon.conversion.Convert类 参考
类 com.foxit.sdk.addon.conversion.Convert 继承关系图:

## Public 成员函数
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void | delete ()
| 直接清除C++相关资源。 更多...

## 静态 Public 成员函数
static boolean | fromDWG (String engine_path, String src_dwg_path, String saved_pdf_path, DWG2PDFSettingData settings) throws com.foxit.sdk.PDFException
| 将DWG格式文件转换为PDF文件。 更多...
static void | fromExcel (String src_excel_file_path, String src_file_password, String saved_pdf_path, Excel2PDFSettingData setting_data, int engine) throws com.foxit.sdk.PDFException
| 将Excel格式文件转换为PDF文件。 更多...
static void | fromHTML (String src_html, String engine_path, String cookies_path, HTML2PDFSettingData setting_data, String saved_pdf_path, int timeout) throws com.foxit.sdk.PDFException
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
static void | fromHTML (String src_html, String engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, String saved_pdf_path, int timeout) throws com.foxit.sdk.PDFException
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
static void | fromHTML (String src_html, String engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, FileWriterCallback saved_pdf_filestream, int timeout) throws com.foxit.sdk.PDFException
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
static void | fromHTML (FileReaderCallback src_html, HTML2PDFRelatedResourceArray html2pdf_related_resource_array, String engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, FileWriterCallback saved_pdf_filestream, int timeout) throws com.foxit.sdk.PDFException
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
static void | fromImage (String src_img, String saved_pdf_path) throws com.foxit.sdk.PDFException
| 将图像格式文件转换为PDF文件。 更多...
static void | fromImage (FileReaderCallback file_reader, FileWriterCallback saved_pdf_filestream) throws com.foxit.sdk.PDFException
| 将图像格式文件转换为PDF文件。 更多...
static boolean | fromOFD (String src_ofd_path, String password, String saved_pdf_file_path, OFDConvertParam convert_param) throws com.foxit.sdk.PDFException
| 将OFD文件转换为PDF文件。 更多...
static void | fromPowerPoint (String src_ppt_file_path, String src_file_password, String saved_pdf_path, PowerPoint2PDFSettingData setting_data, int engine) throws com.foxit.sdk.PDFException
| 将PowerPoint格式文件转换为PDF文件。 更多...
static void | fromTXT (String src_txt, String saved_pdf_path, TXT2PDFSettingData setting_data) throws com.foxit.sdk.PDFException
| 将TXT格式文件转换为PDF文件。 更多...
static void | fromWord (String src_word_file_path, String src_file_password, String saved_pdf_path, Word2PDFSettingData setting_data, int engine) throws com.foxit.sdk.PDFException
| 将Word格式文件转换为PDF文件。 更多...
static boolean | toOFD (String src_pdf_path, String password, String saved_ofd_file_path, OFDConvertParam convert_param) throws com.foxit.sdk.PDFException
| 将PDF文件转换为OFD文件。 更多...
static boolean | toXML (String src_pdf_path, String src_file_password, String saved_xml_path, String saved_image_folder_path, boolean is_force_to_tagged_pdf) throws com.foxit.sdk.PDFException
| 将PDF文件转换为XML格式文件。 更多...

## 静态 Public 属性
static final int | e_Office2PdfEngineMicrosoft = 0
| Microsoft Office 自动化引擎。
static final int | e_Office2PdfEngineWps = 1
| WPS Office 自动化引擎。

## 详细描述

转换插件模块可用于PDF文件与其他文件格式之间的转换。 在使用此模块中的任何类或方法之前，请确保Foxit PDF SDK已通过 函数common.Library.initialize 使用包含"Conversion"模块的密钥成功初始化。 在使用函数Convert.fromDWG 之前，请确保Foxit PDF SDK已通过 从版本11.0开始，我们不再更新和维护linux x86平台上的HTML2PDF引擎包， 在未来版本中可能会在linux x86平台上弃用。

参见
  com.foxit.sdk.common.Library

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.addon.conversion.Convert.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ fromDWG()

static boolean com.foxit.sdk.addon.conversion.Convert.fromDWG | ( | String | engine_path,
|  | String | src_dwg_path,
|  | String | saved_pdf_path,
|  | DWG2PDFSettingData | settings
| ) |  | throws com.foxit.sdk.PDFException
| static

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

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

参数

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

返回
  无。

## ◆ fromExcel()

static void com.foxit.sdk.addon.conversion.Convert.fromExcel | ( | String | src_excel_file_path,
|  | String | src_file_password,
|  | String | saved_pdf_path,
|  | Excel2PDFSettingData | setting_data,
|  | int | engine
| ) |  | throws com.foxit.sdk.PDFException
| 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 | 使用的转换引擎。请参考从 com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 。

返回
  无。

## ◆ fromHTML() [1/4]

static void com.foxit.sdk.addon.conversion.Convert.fromHTML | ( | String | src_html,
|  | String | engine_path,
|  | String | cookies_path,
|  | HTML2PDFSettingData | setting_data,
|  | String | saved_pdf_path,
|  | int | timeout
| ) |  | throws com.foxit.sdk.PDFException
| static

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

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

参数

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

返回
  无。

## ◆ fromHTML() [2/4]

static void com.foxit.sdk.addon.conversion.Convert.fromHTML | ( | String | src_html,
|  | String | engine_path,
|  | FileReaderCallback | cookies_reader,
|  | HTML2PDFSettingData | setting_data,
|  | String | saved_pdf_path,
|  | int | timeout
| ) |  | throws com.foxit.sdk.PDFException
| static

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

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

参数

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

返回
  无。

## ◆ fromHTML() [3/4]

static void com.foxit.sdk.addon.conversion.Convert.fromHTML | ( | String | src_html,
|  | String | engine_path,
|  | FileReaderCallback | cookies_reader,
|  | HTML2PDFSettingData | setting_data,
|  | FileWriterCallback | saved_pdf_filestream,
|  | int | timeout
| ) |  | throws com.foxit.sdk.PDFException
| static

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

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

参数

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

返回
  无。

## ◆ fromHTML() [4/4]

static void com.foxit.sdk.addon.conversion.Convert.fromHTML | ( | FileReaderCallback | src_html,
|  | HTML2PDFRelatedResourceArray | html2pdf_related_resource_array,
|  | String | engine_path,
|  | FileReaderCallback | cookies_reader,
|  | HTML2PDFSettingData | setting_data,
|  | FileWriterCallback | saved_pdf_filestream,
|  | int | timeout
| ) |  | throws com.foxit.sdk.PDFException
| static

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

目前，此函数只能在桌面平台和mac arm平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。

参数

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

返回
  无。

## ◆ fromImage() [1/2]

static void com.foxit.sdk.addon.conversion.Convert.fromImage | ( | String | src_img,
|  | String | saved_pdf_path
| ) |  | throws com.foxit.sdk.PDFException
| static

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

参数

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

返回
  无。

## ◆ fromImage() [2/2]

static void com.foxit.sdk.addon.conversion.Convert.fromImage | ( | FileReaderCallback | file_reader,
|  | FileWriterCallback | saved_pdf_filestream
| ) |  | throws com.foxit.sdk.PDFException
| static

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

参数

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

返回
  无。

## ◆ fromOFD()

static boolean com.foxit.sdk.addon.conversion.Convert.fromOFD | ( | String | src_ofd_path,
|  | String | password,
|  | String | saved_pdf_file_path,
|  | OFDConvertParam | convert_param
| ) |  | throws com.foxit.sdk.PDFException
| static

将OFD文件转换为PDF文件。

在使用此函数之前，请确保已成功调用common.Library.initializeOFDEngine 。

参数

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

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

## ◆ fromPowerPoint()

static void com.foxit.sdk.addon.conversion.Convert.fromPowerPoint | ( | String | src_ppt_file_path,
|  | String | src_file_password,
|  | String | saved_pdf_path,
|  | PowerPoint2PDFSettingData | setting_data,
|  | int | engine
| ) |  | throws com.foxit.sdk.PDFException
| 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 | 使用的转换引擎。请参考从 com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 。

返回
  无。

## ◆ fromTXT()

static void com.foxit.sdk.addon.conversion.Convert.fromTXT | ( | String | src_txt,
|  | String | saved_pdf_path,
|  | TXT2PDFSettingData | setting_data
| ) |  | throws com.foxit.sdk.PDFException
| static

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

参数

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

返回
  无。

## ◆ fromWord()

static void com.foxit.sdk.addon.conversion.Convert.fromWord | ( | String | src_word_file_path,
|  | String | src_file_password,
|  | String | saved_pdf_path,
|  | Word2PDFSettingData | setting_data,
|  | int | engine
| ) |  | throws com.foxit.sdk.PDFException
| 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 | 使用的转换引擎。请参考从 com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 开始的值， 应该是这些值中的一个。默认值：com.foxit.sdk.addon.conversion.Convert.e_Office2PdfEngineMicrosoft 。

返回
  无。

## ◆ toOFD()

static boolean com.foxit.sdk.addon.conversion.Convert.toOFD | ( | String | src_pdf_path,
|  | String | password,
|  | String | saved_ofd_file_path,
|  | OFDConvertParam | convert_param
| ) |  | throws com.foxit.sdk.PDFException
| static

将PDF文件转换为OFD文件。

在使用此函数之前，请确保已成功调用common.Library.initializeOFDEngine 。

参数

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

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

## ◆ toXML()

static boolean com.foxit.sdk.addon.conversion.Convert.toXML | ( | String | src_pdf_path,
|  | String | src_file_password,
|  | String | saved_xml_path,
|  | String | saved_image_folder_path,
|  | boolean | is_force_to_tagged_pdf
| ) |  | throws com.foxit.sdk.PDFException
| 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表示失败。