foxit::addon::conversion::Convert类 参考
类 foxit::addon::conversion::Convert 继承关系图:
Public 类型 | |
| enum | Office2PdfEngine { e_Office2PdfEngineMicrosoft = 0, e_Office2PdfEngineWps = 1 } |
| 用于 Windows 平台将 Office 转换为 PDF 的引擎类型枚举。 更多... | |
静态 Public 成员函数 | |
| static bool | FromDWG (const wchar_t *engine_path, const wchar_t *src_dwg_path, const wchar_t *saved_pdf_path, const DWG2PDFSettingData &settings) |
| 将DWG格式文件转换为PDF文件。 更多... | |
| static void | FromHTML (const wchar_t *src_html, const wchar_t *engine_path, const wchar_t *cookies_path, const HTML2PDFSettingData &setting_data, const wchar_t *saved_pdf_path, int32 timeout) |
| 将HTML格式文件或网页URL转换为PDF文件。 更多... | |
| static void | FromHTML (const wchar_t *src_html, const wchar_t *engine_path, foxit::common::file::ReaderCallback *cookies_reader, const HTML2PDFSettingData &setting_data, const wchar_t *saved_pdf_path, int32 timeout) |
| 将HTML格式文件或网页URL转换为PDF文件。 更多... | |
| static void | FromHTML (const wchar_t *src_html, const wchar_t *engine_path, foxit::common::file::ReaderCallback *cookies_reader, const HTML2PDFSettingData &setting_data, foxit::common::file::WriterCallback *saved_pdf_filestream, int32 timeout) |
| 将HTML格式文件或网页URL转换为PDF文件。 更多... | |
| static void | FromHTML (foxit::common::file::ReaderCallback *src_html, const HTML2PDFRelatedResourceArray &html2pdf_related_resource_array, const wchar_t *engine_path, foxit::common::file::ReaderCallback *cookies_reader, const HTML2PDFSettingData &setting_data, foxit::common::file::WriterCallback *saved_pdf_filestream, int32 timeout) |
| 将HTML格式文件或网页URL转换为PDF文件。 更多... | |
| static void | FromImage (const wchar_t *src_img, const wchar_t *saved_pdf_path) |
| 将图像格式文件转换为PDF文件。 更多... | |
| static void | FromImage (foxit::common::file::ReaderCallback *file_reader, foxit::common::file::WriterCallback *saved_pdf_filestream) |
| 将图像格式文件转换为PDF文件。 更多... | |
| static void | FromTXT (const wchar_t *src_txt, const wchar_t *saved_pdf_path, const TXT2PDFSettingData &setting_data) |
| 将TXT格式文件转换为PDF文件。 更多... | |
| static bool | ToXML (const wchar_t *src_pdf_path, const wchar_t *src_file_password, const wchar_t *saved_xml_path, const wchar_t *saved_image_folder_path, bool is_force_to_tagged_pdf) |
| 将PDF文件转换为XML格式文件。 更多... | |
额外继承的成员函数 | |
 Public 成员函数 继承自 foxit::Base | |
| FS_HANDLE | Handle () const |
| 获取当前对象的句柄。 更多... | |
详细描述
转换插件模块可用于PDF文件与其他文件格式之间的转换。 在使用此模块中的任何类或方法之前，请确保Foxit PDF SDK已通过 函数common::Library::Initialize使用包含"Conversion"模块的密钥成功初始化。 在使用函数Convert::FromDWG之前，请确保Foxit PDF SDK已通过 从版本11.0开始，我们不再更新和维护linux x86平台上的HTML2PDF引擎包， 在未来版本中可能会在linux x86平台上弃用。
成员枚举类型说明
◆ Office2PdfEngine
成员函数说明
◆ FromDWG()
|
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]
|
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 |
将HTML格式文件或网页URL转换为PDF文件。
目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。
- 参数
-
[in] src_html 网页URL或HTML格式文件路径。这不应该是空字符串。 [in] engine_path "HTML到PDF"引擎的目录路径。这不应该是空字符串。 [in] cookies_reader 用户实现的common::file::ReaderCallback对象， 用于向Foxit PDF SDK传递cookie数据。如果这是NULL，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。 [in] setting_data 用于转换的设置数据。 [in] saved_pdf_path 保存转换后PDF文件的路径。这不应该是空字符串。 [in] timeout 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
- 返回
- 无。
◆ FromHTML() [3/4]
|
static |
将HTML格式文件或网页URL转换为PDF文件。
目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。
- 参数
-
[in] src_html 网页URL或HTML格式文件路径。这不应该是空字符串。 [in] engine_path "HTML到PDF"引擎的目录路径。这不应该是空字符串。 [in] cookies_reader 用户实现的common::file::ReaderCallback对象， 用于向Foxit PDF SDK传递cookie数据。如果这是NULL，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。 [in] setting_data 用于转换的设置数据。 [in] saved_pdf_filestream 用于保存转换后PDF文件的common::file::WriterCallback对象。这不应该是NULL。 [in] timeout 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
- 返回
- 无。
◆ FromHTML() [4/4]
|
static |
将HTML格式文件或网页URL转换为PDF文件。
目前，此函数只能在桌面平台和mac arm平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。
- 参数
-
[in] src_html 用户实现的common::file::ReaderCallback对象， 用于向Foxit PDF SDK传递html数据。必须是有效的。 [in] html2pdf_related_resource_array 与源HTML相关的HTML2PDFRelatedResourceArray。 [in] engine_path "HTML到PDF"引擎的目录路径。这不应该是空字符串。 [in] cookies_reader （保留；尚未支持）用户实现的common::file::ReaderCallback对象， 用于向Foxit PDF SDK传递cookie数据。如果这是NULL，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。 [in] setting_data 用于转换的设置数据。 [in] saved_pdf_filestream 用于保存转换后PDF文件的common::file::WriterCallback对象。这不应该是NULL。 [in] timeout 用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
- 返回
- 无。
◆ FromImage() [1/2]
|
static |
将图像格式文件转换为PDF文件。
- 参数
-
[in] src_img 图像格式文件路径。这不应该是空字符串。 [in] saved_pdf_path 保存转换后PDF文件的路径。这不应该是空字符串。
- 返回
- 无。
◆ FromImage() [2/2]
|
static |
将图像格式文件转换为PDF文件。
- 参数
-
[in] file_reader 用户实现的common::file::ReaderCallback对象， 用于向Foxit PDF SDK传递图像数据。必须是有效的。 [in] saved_pdf_filestream 用于保存转换后PDF文件的common::file::WriterCallback对象。 这不应该是NULL。
- 返回
- 无。
◆ FromTXT()
|
static |
将TXT格式文件转换为PDF文件。
- 参数
-
[in] src_txt TXT格式文件路径。这不应该是空字符串。 [in] saved_pdf_path 保存转换后PDF文件的路径。这不应该是空字符串。 [in] setting_data 用于转换的设置数据。
- 返回
- 无。
◆ ToXML()
|
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表示失败。
