Foxit PDF SDK
foxit::addon::conversion::Convert Class Reference
Inheritance diagram for foxit::addon::conversion::Convert:
foxit::Base

Static Public Member Functions

static void FromExcel (const wchar_t *src_excel_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Excel2PDFSettingData &setting_data)
 Convert a 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 FromWord (const wchar_t *src_word_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Word2PDFSettingData &setting_data)
 Convert a Word format file to a PDF 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 "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
common::Library

Member Function Documentation

◆ 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 Excel2PDFSettingData setting_data 
)
static

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()

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 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.
[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.

◆ 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 Word2PDFSettingData setting_data 
)
static

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.