Foxit PDF Conversion SDK
FoxitPDFConversionSDKPython2.Office2PDF Class Reference
Inheritance diagram for FoxitPDFConversionSDKPython2.Office2PDF:
FoxitPDFConversionSDKPython2.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...
 

Detailed Description

This class can be used to convert Office(Word, Excel or PowerPoint) format files to PDF files. Before using methods in this module, please ensure Foxit PDF Conversion SDK has been initialized successfully by function FoxitPDFConversionSDKPython2.Library.Initialize with a key including "Office2PDF" module.

See also
FoxitPDFConversionSDKPython2.Library

Member Function Documentation

◆ ConvertFromExcel() [1/2]

FoxitPDFConversionSDKPython2.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 FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .

◆ ConvertFromExcel() [2/2]

FoxitPDFConversionSDKPython2.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 Word format file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA FoxitPDFConversionSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .

◆ ConvertFromPowerPoint() [1/2]

FoxitPDFConversionSDKPython2.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 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 FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .

◆ ConvertFromPowerPoint() [2/2]

FoxitPDFConversionSDKPython2.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 ppt 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 FoxitPDFConversionSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .

◆ ConvertFromWord() [1/2]

FoxitPDFConversionSDKPython2.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 FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .

◆ ConvertFromWord() [2/2]

FoxitPDFConversionSDKPython2.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 FoxitPDFConversionSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null.
[in]setting_dataA FoxitPDFConversionSDKPython2.Office2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "Office2PDF" is not defined in the license information which is used in function FoxitPDFConversionSDKPython2.Library.Initialize , that means user has no right in using this function and this function will throw exception FoxitPDFConversionSDKPython2.e_ErrNoOffice2PDFModuleRight .