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 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 FromPowerPoint (const wchar_t *src_ppt_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const PowerPoint2PDFSettingData &setting_data)
 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 Word2PDFSettingData &setting_data)
 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 "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 an 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/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_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.

◆ 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_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 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_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.

◆ 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_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 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_dataSetting data used for converting.
[in]saved_pdf_filestreamA common::file::WriterCallback 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.

◆ 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_htmlA 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_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 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_dataSetting data used for converting.
[in]saved_pdf_filestreamA common::file::WriterCallback 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.

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

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.

◆ 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_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.

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

◆ 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_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.