Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.addon.conversion.Convert Class Reference
Inheritance diagram for foxit.addon.conversion.Convert:
foxit.common.Base

Static Public Member Functions

static void FromExcel (string src_excel_file_path, string src_file_password, string saved_pdf_path, string engine_path, Excel2PDFSettingData setting_data)
 Convert an Excel format file to a PDF file. More...
 
static void FromHTML (string src_html, string engine_path, string cookies_path, HTML2PDFSettingData setting_data, string saved_pdf_path, int timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file. More...
 
static void FromHTML (string src_html, string engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, string saved_pdf_path, int timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file. More...
 
static void FromHTML (string src_html, string engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, FileWriterCallback saved_pdf_filestream, int timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file. More...
 
static void FromHTML (FileReaderCallback src_html, HTML2PDFRelatedResourceArray html2pdf_related_resource_array, string engine_path, FileReaderCallback cookies_reader, HTML2PDFSettingData setting_data, FileWriterCallback saved_pdf_filestream, int timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file. More...
 
static void FromPowerPoint (string src_ppt_file_path, string src_file_password, string saved_pdf_path, string engine_path, PowerPoint2PDFSettingData setting_data)
 Convert a PowerPoint format file to a PDF file. More...
 
static void FromTXT (string src_txt, string saved_pdf_path, TXT2PDFSettingData setting_data)
 Convert a TXT format file to a PDF file. More...
 
static void FromWord (string src_word_file_path, string src_file_password, string saved_pdf_path, string engine_path, Word2PDFSettingData setting_data)
 Convert a Word format file to a PDF file. More...
 
static bool ToXML (string src_pdf_path, string src_file_password, string saved_xml_path, string saved_image_folder_path, bool is_force_to_tagged_pdf)
 Convert a PDF file to a XML format file. More...
 

Detailed Description

Conversion add-on module can be used to do some conversion between PDF file and other file formats. Before using "Conversion" module, user should first prepare font resource folder as described in "Foxit PDF SDK Developer Guide.pdf" document. 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.

See Also
foxit.common.Library

Member Function Documentation

static void foxit.addon.conversion.Convert.FromExcel ( string  src_excel_file_path,
string  src_file_password,
string  saved_pdf_path,
string  engine_path,
Excel2PDFSettingData  setting_data 
)
inlinestatic

Convert an Excel format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop 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 desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_excel_file_pathPath of a Excel format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn 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 desktop 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.
Returns
None.
static void foxit.addon.conversion.Convert.FromHTML ( string  src_html,
string  engine_path,
string  cookies_path,
HTML2PDFSettingData  setting_data,
string  saved_pdf_path,
int  timeout 
)
inlinestatic

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_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_pathPath 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_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds 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.
static void foxit.addon.conversion.Convert.FromHTML ( string  src_html,
string  engine_path,
FileReaderCallback  cookies_reader,
HTML2PDFSettingData  setting_data,
string  saved_pdf_path,
int  timeout 
)
inlinestatic

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_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA foxit.common.fxcrt.FileReaderCallback 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_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds 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.
static void foxit.addon.conversion.Convert.FromHTML ( string  src_html,
string  engine_path,
FileReaderCallback  cookies_reader,
HTML2PDFSettingData  setting_data,
FileWriterCallback  saved_pdf_filestream,
int  timeout 
)
inlinestatic

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_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA foxit.common.fxcrt.FileReaderCallback 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_dataSetting data used for converting.
[in]saved_pdf_filestreamA foxit.common.fxcrt.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds 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.
static void foxit.addon.conversion.Convert.FromHTML ( FileReaderCallback  src_html,
HTML2PDFRelatedResourceArray  html2pdf_related_resource_array,
string  engine_path,
FileReaderCallback  cookies_reader,
HTML2PDFSettingData  setting_data,
FileWriterCallback  saved_pdf_filestream,
int  timeout 
)
inlinestatic

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_htmlA foxit.common.fxcrt.FileReaderCallback object which is implemented by user to pass html data to Foxit PDF SDK. It must be vaild.
[in]html2pdf_related_resource_arrayThe HTML2PDFRelatedResourceArray which is related to source HTML.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_reader(Reserved;Not supported yet)A foxit.common.fxcrt.FileReaderCallback 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_dataSetting data used for converting.
[in]saved_pdf_filestreamA foxit.common.fxcrt.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds 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.
static void foxit.addon.conversion.Convert.FromPowerPoint ( string  src_ppt_file_path,
string  src_file_password,
string  saved_pdf_path,
string  engine_path,
PowerPoint2PDFSettingData  setting_data 
)
inlinestatic

Convert a PowerPoint format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop 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 desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_ppt_file_pathPath of a PowerPoint format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn 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 desktop 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.
Returns
None.
static void foxit.addon.conversion.Convert.FromTXT ( string  src_txt,
string  saved_pdf_path,
TXT2PDFSettingData  setting_data 
)
inlinestatic

Convert a TXT format file to a PDF file.

Parameters
[in]src_txtA TXT format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]setting_dataSetting data used for converting.
Returns
None.
static void foxit.addon.conversion.Convert.FromWord ( string  src_word_file_path,
string  src_file_password,
string  saved_pdf_path,
string  engine_path,
Word2PDFSettingData  setting_data 
)
inlinestatic

Convert a Word format file to a PDF file.

Currently, this function can be used for Linux armv8 or Linux desktop 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 desktop system, then please ensure that LibreOffice is installed on the machine.

Parameters
[in]src_word_file_pathPath of a Word format file. This should not be an empty string.
[in]src_file_passwordPassword for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]engine_pathIn 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 desktop 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.
Returns
None.
static bool foxit.addon.conversion.Convert.ToXML ( string  src_pdf_path,
string  src_file_password,
string  saved_xml_path,
string  saved_image_folder_path,
bool  is_force_to_tagged_pdf 
)
inlinestatic

Convert a PDF file to a XML format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_file_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_xml_pathPath of the saved XML format file as conversion result. This should not be an empty string.
[in]saved_image_folder_pathA 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.