Foxit PDF SDK

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

## 静态 Public 成员函数
def | FromDWG (engine_path, src_dwg_path, saved_pdf_path, settings)
| 将DWG格式文件转换为PDF文件。 更多...
def | FromHTML (src_html, engine_path, cookies_path, setting_data, saved_pdf_path, timeout)
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
def | FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
def | FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_path, timeout)
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
def | FromHTML (src_html, html2pdf_related_resource_array, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
| 将HTML格式文件或网页URL转换为PDF文件。 更多...
def | FromImage (src_img, saved_pdf_path)
| 将图像格式文件转换为PDF文件。 更多...
def | FromTXT (src_txt, saved_pdf_path, setting_data)
| 将TXT格式文件转换为PDF文件。 更多...
def | ToXML (src_pdf_path, src_file_password, saved_xml_path, saved_image_folder_path, is_force_to_tagged_pdf)
| 将PDF文件转换为XML格式文件。 更多...

## 静态 Public 属性
| e_Office2PdfEngineMicrosoft = _fsdk.Convert_e_Office2PdfEngineMicrosoft
| Microsoft Office 自动化引擎。
| e_Office2PdfEngineWps = _fsdk.Convert_e_Office2PdfEngineWps
| WPS Office 自动化引擎。

## 详细描述

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

参见
  FoxitPDFSDKPython3.Library

## 成员函数说明

## ◆ FromDWG()

FoxitPDFSDKPython3.Convert.FromDWG | ( |  | engine_path,
|  |  | 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 | 用于转换的DWG2PDFSettingData 对象。

返回
  无。

## ◆ FromHTML() [1/4]

FoxitPDFSDKPython3.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 | Cookie文件的路径。如果这是空字符串，表示不使用Cookie文件。 强烈建议使用JSON格式的数据格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_path | 保存转换后PDF文件的路径。这不应该是空字符串。
  [in] | timeout | 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。

返回
  无。

## ◆ FromHTML() [2/4]

FoxitPDFSDKPython3.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 | 用户实现的FoxitPDFSDKPython3.FileReaderCallback 对象， 用于向Foxit PDF SDK传递cookie数据。如果这是null，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_filestream | 用于保存转换后PDF文件的FoxitPDFSDKPython3.FileWriterCallback 对象。这不应该是null。
  [in] | timeout | 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。

返回
  无。

## ◆ FromHTML() [3/4]

FoxitPDFSDKPython3.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 | 用户实现的FoxitPDFSDKPython3.FileReaderCallback 对象， 用于向Foxit PDF SDK传递cookie数据。如果这是null，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。
  [in] | setting_data | 用于转换的设置数据。
  [in] | saved_pdf_path | 保存转换后PDF文件的路径。这不应该是空字符串。
  [in] | timeout | 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。

返回
  无。

## ◆ FromHTML() [4/4]

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

返回
  无。

## ◆ FromImage()

FoxitPDFSDKPython3.Convert.FromImage | ( |  | src_img,
|  |  | saved_pdf_path
| ) |  |
| static

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

参数

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

返回
  无。

参数

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

返回
  无。

## ◆ FromTXT()

FoxitPDFSDKPython3.Convert.FromTXT | ( |  | src_txt,
|  |  | saved_pdf_path,
|  |  | setting_data
| ) |  |
| static

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

参数

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

返回
  无。

## ◆ ToXML()

FoxitPDFSDKPython3.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表示失败。