foxit::addon::conversion::office2pdf::Office2PDF类 参考
类 foxit::addon::conversion::office2pdf::Office2PDF 继承关系图:
静态 Public 成员函数 | |
| static bool | ConvertFromExcel (const wchar_t *src_excel_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Office2PDFSettingData &setting_data) |
| 将Excel格式文件转换为PDF文件。 更多... | |
| static bool | ConvertFromExcel (common::file::ReaderCallback *src_excel_reader, const wchar_t *src_file_password, common::file::StreamCallback *saved_pdf_file_stream, const Office2PDFSettingData &setting_data) |
| 将Excel格式文件转换为PDF文件。 更多... | |
| static bool | ConvertFromPowerPoint (const wchar_t *src_ppt_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Office2PDFSettingData &setting_data) |
| 将PowerPoint格式文件转换为PDF文件。 更多... | |
| static bool | ConvertFromPowerPoint (common::file::ReaderCallback *src_ppt_reader, const wchar_t *src_file_password, common::file::StreamCallback *saved_pdf_file_stream, const Office2PDFSettingData &setting_data) |
| 将PowerPoint格式文件转换为PDF文件。 更多... | |
| static bool | ConvertFromWord (const wchar_t *src_word_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Office2PDFSettingData &setting_data) |
| 将Word格式文件转换为PDF文件。 更多... | |
| static bool | ConvertFromWord (common::file::ReaderCallback *src_word_reader, const wchar_t *src_file_password, common::file::StreamCallback *saved_pdf_file_stream, const Office2PDFSettingData &setting_data) |
| 将Word格式文件转换为PDF文件。 更多... | |
| static String | GetVersion () |
| 获取Foxit PDF转换SDK的版本。 更多... | |
| static void | Initialize (const wchar_t *library_path) |
| 初始化Foxit PDF转换。 更多... | |
| static void | Release () |
| 释放Foxit PDF转换分配的所有资源。 更多... | |
额外继承的成员函数 | |
 Public 成员函数 继承自 foxit::Base | |
| FS_HANDLE | Handle () const |
| 获取当前对象的句柄。 更多... | |
详细描述
此类可用于将Office（Word、Excel或PowerPoint）格式文件转换为PDF文件。 此功能是Foxit自主开发的产品，不依赖其他第三方引擎。 在使用"Conversion"模块之前，请确保Foxit PDF转换SDK包中名为"res"和"lib"的资源文件夹有效。 在使用此模块中的方法之前，请确保Foxit PDF SDK已通过函数common::Library::Initialize 使用包含"Office2PDF"模块的密钥成功初始化。
成员函数说明
◆ ConvertFromExcel() [1/2]
|
static |
将Excel格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从XLSX格式文件的转换。
- 参数
-
[in] src_excel_file_path Excel格式文件的路径。这不应该是空字符串。 [in] src_file_password （保留，尚不支持加密文件）输入Excel格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_path 作为转换结果保存的PDF文件路径。这不应该是空字符串。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ ConvertFromExcel() [2/2]
|
static |
将Excel格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从XLSX格式文件的转换。 文件是一次性读取的，而不是逐步读取的。
- 参数
-
[in] src_excel_reader 由用户实现的ReaderCallback对象， 用于加载Excel文档。它不应该是NULL。 [in] src_file_password （保留，尚不支持加密文件）输入Excel格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_file_stream 由用户实现的foxit::common::file::StreamCallback对象， 用于读取转换后PDF文件的内容。它不应该是NULL。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ ConvertFromPowerPoint() [1/2]
|
static |
将PowerPoint格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从PPTX格式文件的转换。
- 参数
-
[in] src_ppt_file_path PowerPoint格式文件的路径。这不应该是空字符串。 [in] src_file_password （保留，尚不支持加密文件）输入PowerPoint格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_path 作为转换结果保存的PDF文件路径。这不应该是空字符串。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ ConvertFromPowerPoint() [2/2]
|
static |
将PowerPoint格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从PPTX格式文件的转换。 文件是一次性读取的，而不是逐步读取的。
- 参数
-
[in] src_ppt_reader 由用户实现的ReaderCallback对象， 用于加载PowerPoint文档。它不应该是NULL。 [in] src_file_password （保留，尚不支持加密文件）输入PowerPoint格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_file_stream 由用户实现的foxit::common::file::StreamCallback对象， 用于读取转换后PDF文件的内容。它不应该是NULL。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ ConvertFromWord() [1/2]
|
static |
将Word格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从DOCX/DOC格式文件的转换。
- 参数
-
[in] src_word_file_path Word格式文件的路径。这不应该是空字符串。 [in] src_file_password （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_path 作为转换结果保存的PDF文件路径。这不应该是空字符串。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ ConvertFromWord() [2/2]
|
static |
将Word格式文件转换为PDF文件。
目前，此函数仅适用于Windows和Linux，并且仅支持从DOCX/DOC格式文件的转换。 文件是一次性读取的，而不是逐步读取的。
- 参数
-
[in] src_word_reader 由用户实现的ReaderCallback对象， 用于加载Word文档。它不应该是NULL。 [in] src_file_password （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。 [in] saved_pdf_file_stream 由用户实现的foxit::common::file::StreamCallback对象， 用于读取转换后PDF文件的内容。它不应该是NULL。 [in] setting_data 用于转换的conversion::office2pdf::Office2PDFSettingData对象。
- 返回
- true表示成功，而false表示失败。
◆ GetVersion()
|
static |
◆ Initialize()
|
static |
初始化Foxit PDF转换。
在"Office2PDF"模块的生命周期内，此函数只能调用一次， 并且应该在"Office2PDF"模块中任何其他函数被调用之前首先调用。
- 参数
-
[in] library_path Foxit PDF转换SDK库的路径。这不应该是空字符串。
- 返回
- 无。
- 注解
- 如果在函数common::Library::Initialize中使用的许可证信息中未定义模块"Office2PDF"， 这意味着用户没有使用Office2PDF相关函数的权限， 此函数将抛出异常foxit::e_ErrNoOffice2PDFModuleRight。
◆ Release()
|
static |
释放Foxit PDF转换分配的所有资源。
当用户不使用"Office2PDF"模块时，应调用此函数释放库分配的所有内存块。
- 返回
- 无。
