Foxit PDF SDK

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

## 静态 Public 成员函数
static | GetVersion ()
| 获取 Foxit PDF Conversion SDK 的版本。 更多...
static | Initialize (library_path, fx_engine_path)
| 初始化 Foxit PDF Conversion。 更多...
static | Release ()
| 释放 Foxit PDF Conversion SDK 库分配的所有资源。 更多...
static | SetConvertCheckCallback (convert_check_callback)
| 设置回调对象以检查 PDF 到 Office 转换条件。 更多...
static | StartConvertToExcel (src_pdf_path, src_pdf_password, saved_excel_file_path, setting_data, convert_callback)
| 开始将 PDF 文件转换为 Excel 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...
static | StartConvertToExcel (src_pdf_reader, src_pdf_password, saved_excel_file_stream, setting_data, convert_callback)
| 开始将 PDF 文件转换为 Excel 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...
static | StartConvertToPowerPoint (src_pdf_path, src_pdf_password, saved_ppt_file_path, setting_data, convert_callback)
| 开始将 PDF 文件转换为 PowerPoint 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...
static | StartConvertToPowerPoint (src_pdf_reader, src_pdf_password, saved_ppt_file_stream, setting_data, convert_callback)
| 开始将 PDF 文件转换为 PowerPoint 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...
static | StartConvertToWord (src_pdf_path, src_pdf_password, saved_word_file_path, setting_data, convert_callback)
| 开始将 PDF 文件转换为 Word 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...
static | StartConvertToWord (src_pdf_reader, src_pdf_password, saved_word_file_stream, setting_data, convert_callback)
| 开始将 PDF 文件转换为 Word 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。 更多...

## 详细描述

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

参见
  FSDK.Library

## 成员函数说明

## ◆ GetVersion()

static FSDK::PDF2Office::GetVersion | ( |  | ) |
| static

获取 Foxit PDF Conversion SDK 的版本。

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

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

## ◆ Initialize()

static FSDK::PDF2Office::Initialize | ( | library_path | ,
|  | fx_engine_path |
| ) |  |
| static

初始化 Foxit PDF Conversion。

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

参数

  [in] | library_path | Foxit PDF Conversion SDK 库的路径。这不应该是空字符串。
  [in] | fx_engine_path | Foxit PDF Conversion 引擎的路径。它可以是空字符串。如果该参数 为空，将直接调用 PDF Conversion SDK 库进行 PDF 到 Office 的转换， 否则将通过 Foxit PDF Conversion 引擎调用 Foxit PDF Conversion SDK 库进行 PDF 到 Office 的转换。

返回
  无。

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

## ◆ Release()

static FSDK::PDF2Office::Release | ( |  | ) |
| static

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

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

返回
  无。

## ◆ SetConvertCheckCallback()

static FSDK::PDF2Office::SetConvertCheckCallback | ( | convert_check_callback |  | ) |
| static

设置回调对象以检查 PDF 到 Office 转换条件。

此方法允许您指定一个自定义转换检查回调，当转换 PDF 文档所需的权限不满足时， 该回调将被调用以根据用户定义的逻辑评估是否应该继续从 PDF 到 Office 的转换。

参数

  [in] | convert_check_callback | 基于回调类 FSDK.ConvertCheckCallback 实现的自定义转换检查回调。 如果为 NULL，将移除自定义转换检查回调， 并使用默认转换检查。

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

## ◆ StartConvertToExcel() [1/2]

static FSDK::PDF2Office::StartConvertToExcel | ( | src_pdf_path | ,
|  | src_pdf_password | ,
|  | saved_excel_file_path | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 Excel 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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

## ◆ StartConvertToExcel() [2/2]

static FSDK::PDF2Office::StartConvertToExcel | ( | src_pdf_reader | ,
|  | src_pdf_password | ,
|  | saved_excel_file_stream | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 Excel 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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

## ◆ StartConvertToPowerPoint() [1/2]

static FSDK::PDF2Office::StartConvertToPowerPoint | ( | src_pdf_path | ,
|  | src_pdf_password | ,
|  | saved_ppt_file_path | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 PowerPoint 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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

## ◆ StartConvertToPowerPoint() [2/2]

static FSDK::PDF2Office::StartConvertToPowerPoint | ( | src_pdf_reader | ,
|  | src_pdf_password | ,
|  | saved_ppt_file_stream | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 PowerPoint 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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

## ◆ StartConvertToWord() [1/2]

static FSDK::PDF2Office::StartConvertToWord | ( | src_pdf_path | ,
|  | src_pdf_password | ,
|  | saved_word_file_path | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 Word 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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

## ◆ StartConvertToWord() [2/2]

static FSDK::PDF2Office::StartConvertToWord | ( | src_pdf_reader | ,
|  | src_pdf_password | ,
|  | saved_word_file_stream | ,
|  | setting_data | ,
|  | convert_callback |
| ) |  |
| static

开始将 PDF 文件转换为 Word 格式文件。必须在调用此函数之前调用函数 FSDK.Initialize。

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

参数

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

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