Foxit PDF Conversion SDK

静态 Public 成员函数 | 所有成员列表
FoxitPDFConversionSDKPython3.PDF2Office类 参考
类 FoxitPDFConversionSDKPython3.PDF2Office 继承关系图:

## 静态 Public 成员函数
def | StartConvertToExcel (src_pdf_path, src_pdf_password, saved_excel_file_path, setting_data, convert_callback)
| 开始将PDF文件转换为Excel格式文件。 更多...
def | StartConvertToExcel (src_pdf_reader, src_pdf_password, saved_excel_file_stream, setting_data, convert_callback)
| 开始将PDF文件转换为Excel格式文件。 更多...
def | StartConvertToPowerPoint (src_pdf_path, src_pdf_password, saved_ppt_file_path, setting_data, convert_callback)
| 开始将PDF文件转换为PowerPoint格式文件。 更多...
def | StartConvertToPowerPoint (src_pdf_reader, src_pdf_password, saved_ppt_file_stream, setting_data, convert_callback)
| 开始将PDF文件转换为PowerPoint格式文件。 更多...
def | StartConvertToWord (src_pdf_path, src_pdf_password, saved_word_file_path, setting_data, convert_callback)
| 开始将PDF文件转换为Word格式文件。 更多...
def | StartConvertToWord (src_pdf_reader, src_pdf_password, saved_word_file_stream, setting_data, convert_callback)
| 开始将PDF文件转换为Word格式文件。 更多...

## 详细描述

此类可用于将PDF文件转换为Office(Word、Excel或PowerPoint)格式文件。 在使用"转换"模块之前，请确保PDF Conversion SDK包中名为"res"的资源文件夹是有效的。 在使用此模块中的方法之前，请确保Foxit PDF Conversion SDK已通过 函数 FoxitPDFConversionSDKPython3.Library.Initialize 使用包含"PDF2Office"模块的密钥成功初始化。

参见
  FoxitPDFConversionSDKPython3.Library

## 成员函数说明

## ◆ StartConvertToExcel() [1/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToExcel | ( |  | src_pdf_path,
|  |  | src_pdf_password,
|  |  | saved_excel_file_path,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为XLSX格式文件。

参数

  [in] | src_pdf_path | PDF文件的路径。不应为空字符串。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_excel_file_path | 作为转换结果保存的Excel格式文件的路径。不应为空字符串。 如果保存的Excel格式文件的后缀名不是"xlsx"，则会将新的后缀名"xlsx"添加到原始文件名。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

## ◆ StartConvertToExcel() [2/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToExcel | ( |  | src_pdf_reader,
|  |  | src_pdf_password,
|  |  | saved_excel_file_stream,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为XLSX格式文件。

参数

  [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象， 用于加载PDF文档。不应为 null。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_excel_file_stream | 由用户实现的 FoxitPDFConversionSDKPython3.StreamCallback 对象， 用于读取转换后的Excel格式文件的内容。不应为 null。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

## ◆ StartConvertToPowerPoint() [1/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToPowerPoint | ( |  | src_pdf_path,
|  |  | src_pdf_password,
|  |  | saved_ppt_file_path,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为PPTX格式文件。

参数

  [in] | src_pdf_path | PDF文件的路径。不应为空字符串。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_ppt_file_path | 作为转换结果保存的PowerPoint格式文件的路径。不应为空字符串。 如果保存的PowerPoint格式文件的后缀名不是"pptx"，则会将新的后缀名"pptx"添加到原始文件名。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

## ◆ StartConvertToPowerPoint() [2/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToPowerPoint | ( |  | src_pdf_reader,
|  |  | src_pdf_password,
|  |  | saved_ppt_file_stream,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为PPTX格式文件。

参数

  [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象， 用于加载PDF文档。不应为 null。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_ppt_file_stream | 由用户实现的 FoxitPDFConversionSDKPython3.StreamCallback 对象， 用于读取转换后的PowerPoint格式文件的内容。不应为 null。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

## ◆ StartConvertToWord() [1/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToWord | ( |  | src_pdf_path,
|  |  | src_pdf_password,
|  |  | saved_word_file_path,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为DOCX格式文件。此函数支持识别PDF文档中的标题并 将其转换为Word文档。目前，标题转换仍处于测试阶段，将在后续版本中进一步改进。

参数

  [in] | src_pdf_path | PDF文件的路径。不应为空字符串。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_word_file_path | 作为转换结果保存的Word格式文件的路径。不应为空字符串。 如果保存的Word格式文件的后缀名不是"docx"，则会将新的后缀名"docx"添加到原始文件名。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。

## ◆ StartConvertToWord() [2/2]

FoxitPDFConversionSDKPython3.PDF2Office.StartConvertToWord | ( |  | src_pdf_reader,
|  |  | src_pdf_password,
|  |  | saved_word_file_stream,
|  |  | setting_data,
|  |  | convert_callback
| ) |  |
| static

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

目前仅支持转换为DOCX格式文件。此函数支持识别PDF文档中的标题并 将其转换为Word文档。目前，标题转换仍处于测试阶段，将在后续版本中进一步改进。

参数

  [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象， 用于加载PDF文档。不应为 null。
  [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
  [in] | saved_word_file_stream | 由用户实现的 FoxitPDFConversionSDKPython3.StreamCallback 对象， 用于读取转换后的Word格式文件的内容。不应为 null。
  [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空，则表示将PDF文件的每一页转换为Word格式文件。
  [in] | convert_callback | 由用户实现的 FoxitPDFConversionSDKPython3.ConvertCallback 对象， 用于在转换过程中暂停和通知转换进度。 这可以为 null，表示不暂停和通知转换进度。 如果不为 null，则应为由用户实现的有效 FoxitPDFConversionSDKPython3.ConvertCallback 对象。 默认值：null。

返回
  一个渐进式对象。请通过函数 FoxitPDFConversionSDKPython3.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到100，请调用函数 FoxitPDFConversionSDKPython3.Progressive.Continue 继续进度，直到进度完成。

注解
  如果在函数 FoxitPDFConversionSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"PDF2Office"， 则表示用户无权使用此函数，并且 此函数将抛出异常 FoxitPDFConversionSDKPython3.e_ErrNoPDF2OfficeModuleRight 。