类 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	FromExcel (const wchar_t src_excel_file_path, const wchar_t src_file_password, const wchar_t saved_pdf_path, const wchar_t engine_path, const Excel2PDFSettingData &setting_data, const wchar_t fx_engine_path=L"", const wchar_t specified_user_profile_path=L"")
	将Excel格式文件转换为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 bool	FromOFD (const wchar_t src_ofd_path, const wchar_t password, const wchar_t *saved_pdf_file_path, OFDConvertParam convert_param)
	将OFD文件转换为PDF文件。更多...

static void	FromPowerPoint (const wchar_t src_ppt_file_path, const wchar_t src_file_password, const wchar_t saved_pdf_path, const wchar_t engine_path, const PowerPoint2PDFSettingData &setting_data, const wchar_t fx_engine_path=L"", const wchar_t specified_user_profile_path=L"")
	将PowerPoint格式文件转换为PDF文件。更多...

static void	FromTXT (const wchar_t src_txt, const wchar_t saved_pdf_path, const TXT2PDFSettingData &setting_data)
	将TXT格式文件转换为PDF文件。更多...

static void	FromWord (const wchar_t src_word_file_path, const wchar_t src_file_password, const wchar_t saved_pdf_path, const wchar_t engine_path, const Word2PDFSettingData &setting_data, const wchar_t fx_engine_path=L"", const wchar_t specified_user_profile_path=L"")
	将Word格式文件转换为PDF文件。更多...

static bool	ToOFD (const wchar_t src_pdf_path, const wchar_t password, const wchar_t *saved_ofd_file_path, OFDConvertParam convert_param)
	将PDF文件转换为OFD文件。更多...

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平台上弃用。

参见: common::Library

成员枚举类型说明

◆ Office2PdfEngine

enum foxit::addon::conversion::Convert::Office2PdfEngine

用于 Windows 平台将 Office 转换为 PDF 的引擎类型枚举。

此枚举的值应独立使用。

枚举值
e_Office2PdfEngineMicrosoft	Microsoft Office 自动化引擎。
e_Office2PdfEngineWps	WPS Office 自动化引擎。

成员函数说明

◆ FromDWG()

static bool foxit::addon::conversion::Convert::FromDWG	(	const wchar_t *	engine_path,
		const wchar_t *	src_dwg_path,
		const wchar_t *	saved_pdf_path,
		const DWG2PDFSettingData &	settings
	)

static

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

目前，此函数只能在桌面平台上使用；对于其他平台，此函数将直接返回false而不执行任何操作。

参数

[in]	engine_path	"DWG到PDF"引擎的目录路径。这不应该是空字符串。
[in]	src_dwg_path	DWG或DXF格式文件路径。这不应该是空字符串。
[in]	saved_pdf_path	保存转换后PDF文件的路径。这不应该是空字符串。
[in]	settings	用于转换的DWG2PDFSettingData对象。

返回: 无。

◆ FromExcel()

static void foxit::addon::conversion::Convert::FromExcel	(	const wchar_t *	src_excel_file_path,
		const wchar_t *	src_file_password,
		const wchar_t *	saved_pdf_path,
		const wchar_t *	engine_path,
		const Excel2PDFSettingData &	setting_data,
		const wchar_t *	fx_engine_path = `L""`,
		const wchar_t *	specified_user_profile_path = `L""`
	)

static

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

目前，此函数可用于Linux armv8或Linux x86/64系统。如果您在Linux armv8系统上，请确保机器上安装了WPS专业版。如果您在Linux x86/64系统上，请确保机器上安装了LibreOffice。

参数

[in]	src_excel_file_path	Excel格式文件的路径。这不应该是空字符串。
[in]	src_file_password	输入Excel格式文件的密码。如果文件不需要密码，请传递空字符串。
[in]	saved_pdf_path	保存作为转换结果的PDF文件的路径。这不应该是空字符串。
[in]	engine_path	在linux armv8系统中，用于表示WPS引擎（librpcetapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。可以为空。默认路径："/opt/kingsoft/wps-office/office6"。在linux x86/64系统中，用于表示LibreOffice引擎（soffice.bin）的路径，不能为空。例如，"/usr/lib/libreoffice/program"。
[in]	setting_data	（保留，尚未支持）用于转换的设置数据。
[in]	fx_engine_path	"Office到PDF"引擎的路径。此参数仅适用于Linux x86/64系统。可以为空。如果参数为空，将直接调用LibreOffice引擎进行Excel到PDF转换，否则将通过"Office到PDF"引擎调用LibreOffice引擎进行Excel到PDF转换。
[in]	specified_user_profile_path	用于存储LibreOffice引擎用户配置文件的用户定义目录路径。需要与"Office到PDF"引擎一起使用。可以为空。如果参数为空，LibreOffice引擎将使用默认用户配置文件且不支持多线程，否则LibreOffice引擎将在用户定义目录中创建新的用户配置文件以支持多线程。

返回: 无。

◆ FromHTML() [1/4]

static void foxit::addon::conversion::Convert::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
	)

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 void foxit::addon::conversion::Convert::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
	)

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 void foxit::addon::conversion::Convert::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
	)

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 void foxit::addon::conversion::Convert::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
	)

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 void foxit::addon::conversion::Convert::FromImage	(	const wchar_t *	src_img,
		const wchar_t *	saved_pdf_path
	)

static

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

参数

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

返回: 无。

◆ FromImage() [2/2]

static void foxit::addon::conversion::Convert::FromImage	(	foxit::common::file::ReaderCallback *	file_reader,
		foxit::common::file::WriterCallback *	saved_pdf_filestream
	)

static

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

参数

[in]	file_reader	用户实现的common::file::ReaderCallback对象，用于向Foxit PDF SDK传递图像数据。必须是有效的。
[in]	saved_pdf_filestream	用于保存转换后PDF文件的common::file::WriterCallback对象。这不应该是NULL。

返回: 无。

◆ FromOFD()

static bool foxit::addon::conversion::Convert::FromOFD	(	const wchar_t *	src_ofd_path,
		const wchar_t *	password,
		const wchar_t *	saved_pdf_file_path,
		OFDConvertParam	convert_param
	)

static

将OFD文件转换为PDF文件。

在使用此函数之前，请确保已成功调用common::Library::InitializeOFDEngine。

参数

[in]	src_ofd_path	现有OFD文件的完整路径。不应该是空字符串。
[in]	password	OFD文件的密码。如果OFD文件未加密，应该是空字符串。
[in]	saved_pdf_file_path	转换后PDF文件的完整路径。不应该是空字符串。
[in]	convert_param	转换参数对象。

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

◆ FromPowerPoint()

static void foxit::addon::conversion::Convert::FromPowerPoint	(	const wchar_t *	src_ppt_file_path,
		const wchar_t *	src_file_password,
		const wchar_t *	saved_pdf_path,
		const wchar_t *	engine_path,
		const PowerPoint2PDFSettingData &	setting_data,
		const wchar_t *	fx_engine_path = `L""`,
		const wchar_t *	specified_user_profile_path = `L""`
	)

static

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

目前，此函数可用于Linux armv8或Linux x86/64系统。如果您在Linux armv8系统上，请确保机器上安装了WPS专业版。如果您在Linux x86/64系统上，请确保机器上安装了LibreOffice。

参数

[in]	src_ppt_file_path	PowerPoint格式文件的路径。这不应该是空字符串。
[in]	src_file_password	输入Excel格式文件的密码。如果文件不需要密码，请传递空字符串。
[in]	saved_pdf_path	保存作为转换结果的PDF文件的路径。这不应该是空字符串。
[in]	engine_path	在linux armv8系统中，用于表示WPS引擎（librpcwppapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。可以为空。默认路径："/opt/kingsoft/wps-office/office6"。在linux x86/64系统中，用于表示LibreOffice引擎（soffice.bin）的路径，不能为空。例如，"/usr/lib/libreoffice/program"。
[in]	setting_data	（保留，尚未支持）用于转换的设置数据。
[in]	fx_engine_path	"Office到PDF"引擎的路径。此参数仅适用于Linux x86/64系统。可以为空。如果参数为空，将直接调用LibreOffice引擎进行PowerPoint到PDF转换，否则将通过"Office到PDF"引擎调用LibreOffice引擎进行PowerPoint到PDF转换。
[in]	specified_user_profile_path	用于存储LibreOffice引擎用户配置文件的用户定义目录路径。需要与"Office到PDF"引擎一起使用。可以为空。如果参数为空，LibreOffice引擎将使用默认用户配置文件且不支持多线程，否则LibreOffice引擎将在用户定义目录中创建新的用户配置文件以支持多线程。

返回: 无。

◆ FromTXT()

static void foxit::addon::conversion::Convert::FromTXT	(	const wchar_t *	src_txt,
		const wchar_t *	saved_pdf_path,
		const TXT2PDFSettingData &	setting_data
	)

static

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

参数

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

返回: 无。

◆ FromWord()

static void foxit::addon::conversion::Convert::FromWord	(	const wchar_t *	src_word_file_path,
		const wchar_t *	src_file_password,
		const wchar_t *	saved_pdf_path,
		const wchar_t *	engine_path,
		const Word2PDFSettingData &	setting_data,
		const wchar_t *	fx_engine_path = `L""`,
		const wchar_t *	specified_user_profile_path = `L""`
	)

static

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

目前，此函数可用于Linux armv8或Linux x86/64系统。如果您在Linux armv8系统上，请确保机器上安装了WPS专业版。如果您在Linux x86/64系统上，请确保机器上安装了LibreOffice。

参数

[in]	src_word_file_path	Word格式文件的路径。这不应该是空字符串。
[in]	src_file_password	输入Word格式文件的密码。如果文件不需要密码，请传递空字符串。
[in]	saved_pdf_path	保存作为转换结果的PDF文件的路径。这不应该是空字符串。
[in]	engine_path	在linux armv8系统中，用于表示WPS引擎（librpcwpsapi.so）的路径。例如，"/opt/kingsoft/wps-office/office6"。可以为空。默认路径："/opt/kingsoft/wps-office/office6"。在linux x86/64系统中，用于表示LibreOffice引擎（soffice.bin）的路径，不能为空。例如，"/usr/lib/libreoffice/program"。
[in]	setting_data	（保留，尚未支持）用于转换的设置数据。
[in]	fx_engine_path	"Office到PDF"引擎的路径。此参数仅适用于Linux x86/64系统。可以为空。如果参数为空，将直接调用LibreOffice引擎进行Word到PDF转换，否则将通过"Office到PDF"引擎调用LibreOffice引擎进行Word到PDF转换。
[in]	specified_user_profile_path	用于存储LibreOffice引擎用户配置文件的用户定义目录路径。需要与"Office到PDF"引擎一起使用。可以为空。如果参数为空，LibreOffice引擎将使用默认用户配置文件且不支持多线程，否则LibreOffice引擎将在用户定义目录中创建新的用户配置文件以支持多线程。

返回: 无。

◆ ToOFD()

static bool foxit::addon::conversion::Convert::ToOFD	(	const wchar_t *	src_pdf_path,
		const wchar_t *	password,
		const wchar_t *	saved_ofd_file_path,
		OFDConvertParam	convert_param
	)

static

将PDF文件转换为OFD文件。

在使用此函数之前，请确保已成功调用common::Library::InitializeOFDEngine。

参数

[in]	src_pdf_path	现有PDF文件的完整路径。不应该是空字符串。
[in]	password	PDF文件的密码。如果PDF文件未加密，应该是空字符串。
[in]	saved_ofd_file_path	转换后OFD文件的完整路径。不应该是空字符串。
[in]	convert_param	转换参数对象。

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

◆ ToXML()

static bool foxit::addon::conversion::Convert::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
	)

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

Public 类型

静态 Public 成员函数

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Office2PdfEngine

成员函数说明

◆ FromDWG()

◆ FromExcel()

◆ FromHTML() [1/4]

◆ FromHTML() [2/4]

◆ FromHTML() [3/4]

◆ FromHTML() [4/4]

◆ FromImage() [1/2]

◆ FromImage() [2/2]

◆ FromOFD()

◆ FromPowerPoint()

◆ FromTXT()

◆ FromWord()

◆ ToOFD()

◆ ToXML()