foxit::addon::conversion::Convert Class Reference

Inheritance diagram for foxit::addon::conversion::Convert:

Public Types
enum	Office2PdfEngine { e_Office2PdfEngineMicrosoft = 0, e_Office2PdfEngineWps = 1 }
	Enumeration for engine type used for office to PDF conversion on Windows platforms. More...

Static Public Member Functions
static bool	FromDWG (const wchar_t *engine_path, const wchar_t *src_dwg_path, const wchar_t *saved_pdf_path, const DWG2PDFSettingData &settings)
	Convert a DWG format file to a PDF file. More...
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"")
	Convert an Excel format file to a PDF file. More...
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)
	Convert a HTML format file or a URL of a Web page to a PDF file. More...
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)
	Convert a HTML format file or a URL of a Web page to a PDF file. More...
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)
	Convert a HTML format file or a URL of a Web page to a PDF file. More...
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)
	Convert a HTML format file or a URL of a Web page to a PDF file. More...
static void	FromImage (const wchar_t *src_img, const wchar_t *saved_pdf_path)
	Convert a Image format file to a PDF file. More...
static void	FromImage (foxit::common::file::ReaderCallback *file_reader, foxit::common::file::WriterCallback *saved_pdf_filestream)
	Convert a Image format file to a PDF file. More...
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"")
	Convert a PowerPoint format file to a PDF file. More...
static void	FromTXT (const wchar_t *src_txt, const wchar_t *saved_pdf_path, const TXT2PDFSettingData &setting_data)
	Convert a TXT format file to a PDF file. More...
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"")
	Convert a Word format file to a PDF file. More...
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)
	Convert a PDF file to a XML format file. More...

Additional Inherited Members
Public Member Functions inherited from foxit::Base
FS_HANDLE	Handle () const
	Get the handle of current object. More...

Detailed Description

Conversion add-on module can be used to do some conversion between PDF file and other file formats. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common::Library::Initialize with a key including "Conversion" module. Before using function Convert::FromDWG, please ensure Foxit PDF SDK has been initialized successfully by function common::Library::Initialize with a key including "DWG2PDF" module. From version 11.0, we do not update and maintance HTML2PDF engine package on linux x86 platform and maybe it will be deprecated in the future version on linux x86 platform.

See also

common::Library

Member Enumeration Documentation

Office2PdfEngine

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

Enumeration for engine type used for office to PDF conversion on Windows platforms.

Values of this enumeration should be used alone.

Enumerator
e_Office2PdfEngineMicrosoft	Microsoft Office automation engine.
e_Office2PdfEngineWps	WPS Office automation engine.

Member Function Documentation

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

Convert a DWG format file to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return false directly without doing anything.

Parameters

[in]	engine_path	The directory path of "DWG to PDF" engine. This should not be an empty string.
[in]	src_dwg_path	A DWG or DXF format file path. This should not be an empty string.
[in]	saved_pdf_path	A path for saving the converted PDF file. This should not be an empty string.
[in]	settings	The DWG2PDFSettingData object used for converting.

Returns

true means success, while false means failure.

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

Convert an Excel format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux x86/x86_64 system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux x86/x86_64 system, then please ensure that LibreOffice is installed on the machine.

Parameters

[in]	src_excel_file_path	Path of a Excel format file. This should not be an empty string.
[in]	src_file_password	Password for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]	saved_pdf_path	Path of the saved PDF file as conversion result. This should not be an empty string.
[in]	engine_path	In linux armv8 system, it is used to represent the path of WPS engine(librpcetapi.so). For examples, "/opt/kingsoft/wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux x86/x86_64 system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]	setting_data	(Reserved, unsupported yet)Setting data used for converting.
[in]	fx_engine_path	The path of "Office to PDF" engine. This parameter is applicable only to Linux x86/x86_64 systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for Excel to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for Excel to PDF conversion.
[in]	specified_user_profile_path	The User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.

Returns

None.

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

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters

[in]	src_html	A URL of Web page or a HTML format file path. This should not be an empty string.
[in]	engine_path	The directory path of "HTML to PDF" engine. This should not be an empty string.
[in]	cookies_path	Path of cookies file. If this is an empty string, that means no cookie file is used. Data format is strongly recommended to use JSON format.
[in]	setting_data	Setting data used for converting.
[in]	saved_pdf_path	A path for saving the converted PDF file. This should not be an empty string.
[in]	timeout	Seconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.

Returns

None.

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

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters

[in]	src_html	A URL of Web page or a HTML format file path. This should not be an empty string.
[in]	engine_path	The directory path of "HTML to PDF" engine. This should not be an empty string.
[in]	cookies_reader	A common::file::ReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is NULL, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]	setting_data	Setting data used for converting.
[in]	saved_pdf_path	A path for saving the converted PDF file. This should not be an empty string.
[in]	timeout	Seconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.

Returns

None.

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

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters

[in]	src_html	A URL of Web page or a HTML format file path. This should not be an empty string.
[in]	engine_path	The directory path of "HTML to PDF" engine. This should not be an empty string.
[in]	cookies_reader	A common::file::ReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is NULL, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]	setting_data	Setting data used for converting.
[in]	saved_pdf_filestream	A common::file::WriterCallback object for saving the converted PDF file. This should not be NULL.
[in]	timeout	Seconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.

Returns

None.

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

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms and mac arm platforms; for other platform, this function will return directly without doing anything.

Parameters

[in]	src_html	A common::file::ReaderCallback object which is implemented by user to pass html data to Foxit PDF SDK. It must be vaild.
[in]	html2pdf_related_resource_array	The HTML2PDFRelatedResourceArray which is related to source HTML.
[in]	engine_path	The directory path of "HTML to PDF" engine. This should not be an empty string.
[in]	cookies_reader	(Reserved;Not supported yet)A common::file::ReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is NULL, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]	setting_data	Setting data used for converting.
[in]	saved_pdf_filestream	A common::file::WriterCallback object for saving the converted PDF file. This should not be NULL.
[in]	timeout	Seconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.

Returns

None.

FromImage() [1/2]

static void foxit::addon::conversion::Convert::FromImage ( const wchar_t *  src_img, const wchar_t *  saved_pdf_path  )

static

Convert a Image format file to a PDF file.

Parameters

[in]	src_img	A image format file path. This should not be an empty string.
[in]	saved_pdf_path	A path for saving the converted PDF file. This should not be an empty string.

Returns

None.

FromImage() [2/2]

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

static

Convert a Image format file to a PDF file.

Parameters

[in]	file_reader	A common::file::ReaderCallback object which is implemented by user to pass image data to Foxit PDF SDK. It must be valid.
[in]	saved_pdf_filestream	A common::file::WriterCallback object for saving the converted PDF file. This should not be NULL.

Returns

None.

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

Convert a PowerPoint format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux x86/x86_64 system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux x86/x86_64 system, then please ensure that LibreOffice is installed on the machine.

Parameters

[in]	src_ppt_file_path	Path of a PowerPoint format file. This should not be an empty string.
[in]	src_file_password	Password for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]	saved_pdf_path	Path of the saved PDF file as conversion result. This should not be an empty string.
[in]	engine_path	In linux armv8 system, it is used to represent the path of WPS engine(librpcwppapi.so). For examples, "/opt/kingsoft/wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux x86/x86_64 system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]	setting_data	(Reserved, unsupported yet)Setting data used for converting.
[in]	fx_engine_path	The path of "Office to PDF" engine. This parameter is applicable only to Linux x86/x86_64 systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for PowerPoint to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for PowerPoint to PDF conversion.
[in]	specified_user_profile_path	The User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.

Returns

None.

FromTXT()

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

static

Convert a TXT format file to a PDF file.

Parameters

[in]	src_txt	A TXT format file path. This should not be an empty string.
[in]	saved_pdf_path	A path for saving the converted PDF file. This should not be an empty string.
[in]	setting_data	Setting data used for converting.

Returns

None.

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

Convert a Word format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux x86/x86_64 system. If you are on a Linux armv8 system, then please ensure that WPS professional is installed on the machine. If you are on a Linux x86/x86_64 system, then please ensure that LibreOffice is installed on the machine.

Parameters

[in]	src_word_file_path	Path of a Word format file. This should not be an empty string.
[in]	src_file_password	Password for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]	saved_pdf_path	Path of the saved PDF file as conversion result. This should not be an empty string.
[in]	engine_path	In linux armv8 system, it is used to represent the path of WPS engine(librpcwpsapi.so). For examples, "/opt/kingsoft/wps-office/office6". It can be empty. Default path: "/opt/kingsoft/wps-office/office6". In linux x86/x86_64 system, it is used to represent the path of LibreOffice engine(soffice.bin), and it can not be empty. For examples, "/usr/lib/libreoffice/program".
[in]	setting_data	(Reserved, unsupported yet)Setting data used for converting.
[in]	fx_engine_path	The path of "Office to PDF" engine. This parameter is applicable only to Linux x86/x86_64 systems. It can be empty. If the parameter is empty, LibreOffice engine will be called directly for Word to PDF conversion, otherwise LibreOffice engine will be called through the "Office to PDF" engine for Word to PDF conversion.
[in]	specified_user_profile_path	The User-defined directory path to store the user profile of the LibreOffice engine. It needs to be used with "Office to PDF" engine. It can be empty. If the parameter is empty, the LibreOffice engine will use the default user profile and does not suppot multi-threading, otherwise LibreOffice engine will create a new user profile in the User-defined directory to support multi-threading.

Returns

None.

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

Convert a PDF file to a XML format file.

Parameters

[in]	src_pdf_path	Path of a PDF file. This should not be an empty string.
[in]	src_file_password	Password for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]	saved_xml_path	Path of the saved XML format file as conversion result. This should not be an empty string.
[in]	saved_image_folder_path	A path to specify a folder where image files will be generated during the converting. If this is an empty string, image files will be generated to a folder named "images" (if not exist, Foxit PDF SDK will generate such folder by default). Folder "images" would be in the same directory with saved XML format file (as parameter saved_xml_path).
[in]	is_force_to_tagged_pdf	(Only useful when input PDF file is not a tagged PDF file) A boolean value to decide whether input PDF file is allowed to be converted to a tagged PDF when input PDF file is not a tagged PDF: true means input PDF file (which is not tagged PDF yet) will first be converted to a tagged PDF. Then the tagged PDF will be converted to a XML format file. false means not allow to convert input PDF file (which is not tagged PDF yet) to a tagged PDF. In this case, input PDF file will not be converted to XML format file and this function will return false.

Returns

true means success, while false means failure.