Foxit PDF SDK
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, Excel2PDFSettingData setting_data)
 Convert a 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 FromPowerPoint (string src_ppt_file_path, string src_file_password, string saved_pdf_path, PowerPoint2PDFSettingData setting_data)
 Convert a PowerPoint format file to a PDF file. More...
 
static void FromWord (string src_word_file_path, string src_file_password, string saved_pdf_path, Word2PDFSettingData setting_data)
 Convert a Word format file to a PDF 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

◆ FromExcel()

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

Convert a Excel format file to a PDF file.

Currently, this function can only be used for Windows.

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]setting_dataSetting data used for converting.
Returns
None.

◆ FromHTML() [1/2]

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 Windows and Mac OS; 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.
Currently, this parameter is only supported to be used in Windows.
[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 webpages. 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/2]

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 Windows and Mac OS; 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.
Currently, this parameter is only supported to be used in Windows.
[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 webpages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ FromPowerPoint()

static void foxit.addon.conversion.Convert.FromPowerPoint ( string  src_ppt_file_path,
string  src_file_password,
string  saved_pdf_path,
PowerPoint2PDFSettingData  setting_data 
)
inlinestatic

Convert a PowerPoint format file to a PDF file.

Currently, this function can only be used for Windows.

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]setting_dataSetting data used for converting.
Returns
None.

◆ FromWord()

static void foxit.addon.conversion.Convert.FromWord ( string  src_word_file_path,
string  src_file_password,
string  saved_pdf_path,
Word2PDFSettingData  setting_data 
)
inlinestatic

Convert a Word format file to a PDF file.

Currently, this function can only be used for Windows.

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]setting_dataSetting data used for converting.
Returns
None.