Foxit PDF SDK
FoxitPDFSDKPython3.Office2PDF Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Office2PDF:
FoxitPDFSDKPython3.Base

Static Public Member Functions

def ConvertFromExcel (src_excel_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert an Excel format file to a PDF file. More...
 
def ConvertFromExcel (src_excel_reader, src_file_password, saved_pdf_file_stream, setting_data)
 Convert an Excel format file to a PDF file. More...
 
def ConvertFromPowerPoint (src_ppt_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert a PowerPoint format file to a PDF file. More...
 
def ConvertFromPowerPoint (src_ppt_reader, src_file_password, saved_pdf_file_stream, setting_data)
 Convert a PowerPoint format file to a PDF file. More...
 
def ConvertFromWord (src_word_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert a Word format file to a PDF file. More...
 
def ConvertFromWord (src_word_reader, src_file_password, saved_pdf_file_stream, setting_data)
 Convert a Word format file to a PDF file. More...
 
def Initialize (library_path)
 Initialize Foxit PDF Conversion. More...
 
def Release ()
 Release all resource allocated by Foxit PDF Conversion. More...
 

Detailed Description

This class can be used to convert Office(Word, Excel or PowerPoint) format files to PDF files. This feature is a self- developed product by Foxit and does not rely on other third-party engines. Before using "Conversion" module, please ensure the resource folders named "res" and "lib" in the Foxit PDF Conversion SDK package is valid. Before using methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "Office2PDF" module.

See also
FoxitPDFSDKPython3.Library

Member Function Documentation

◆ ConvertFromExcel() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromExcel (   src_excel_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

Convert an Excel format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from XLSX format files.

Parameters
[in]src_excel_file_pathPath of an Excel format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password 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_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ ConvertFromExcel() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromExcel (   src_excel_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

Convert an Excel format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from XLSX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_excel_readerA FileReaderCallback object which is implemented by user to load an excel document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Excel format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA FoxitPDFSDKPython3.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ ConvertFromPowerPoint() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromPowerPoint (   src_ppt_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

Convert a PowerPoint format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from PPTX format files.

Parameters
[in]src_ppt_file_pathPath of a PowerPoint format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input PowerPoint 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_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ ConvertFromPowerPoint() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromPowerPoint (   src_ppt_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

Convert a PowerPoint format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from PPTX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_ppt_readerA FileReaderCallback object which is implemented by user to load a PowerPoint document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input PowerPoint format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA FoxitPDFSDKPython3.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ ConvertFromWord() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromWord (   src_word_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

Convert a Word format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from DOCX format files.

Parameters
[in]src_word_file_pathPath of a Word format file. This should not be an empty string.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password 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_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ ConvertFromWord() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromWord (   src_word_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

Convert a Word format file to a PDF file.

Currently,this function is only available for Windows, and it supports conversion only from DOCX format files. The file is read all at once, rather than progressively.

Parameters
[in]src_word_readerA FileReaderCallback object which is implemented by user to load a word document. It should not be null.
[in]src_file_password(Reserved,encrypted files are unsupported yet)Password for the input Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA FoxitPDFSDKPython3.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFSDKPython3.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.

◆ Initialize()

FoxitPDFSDKPython3.Office2PDF.Initialize (   library_path)
static

Initialize Foxit PDF Conversion.

During the life-cycle of "Office2PDF" module, this function can only be called once and should be called first before any other functions in "Office2PDF" module can be called.

Parameters
[in]library_pathPath of Foxit PDF Conversion SDK library. This should not be an empty string.
Returns
None.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFSDKPython3.Library.Initialize , that means user has no right in using Office2PDF related functions and this function will throw exception FoxitPDFSDKPython3.e_ErrNoOffice2PDFModuleRight .

◆ Release()

FoxitPDFSDKPython3.Office2PDF.Release ( )
static

Release all resource allocated by Foxit PDF Conversion.

When the user does not use "Office2PDF" module, this function should be called to release all memory blocks allocated by the library.

Returns
None.