Foxit PDF SDK
FoxitPDFSDKPython2.PDF2Office Class Reference
Inheritance diagram for FoxitPDFSDKPython2.PDF2Office:
FoxitPDFSDKPython2.Base

Static Public Attributes

 Initialize = _fsdk.PDF2Office_Initialize
 Initialize Foxit PDF Conversion SDK Library. More...
 
 Release = _fsdk.PDF2Office_Release
 Release all resource allocated by Foxit PDF Conversion SDK Library. More...
 
 StartConvertToExcel = _fsdk.PDF2Office_StartConvertToExcel
 Start to convert a PDF file to a Excel format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function. More...
 
 StartConvertToPowerPoint = _fsdk.PDF2Office_StartConvertToPowerPoint
 Start to convert a PDF file to a PowerPoint format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function. More...
 
 StartConvertToWord = _fsdk.PDF2Office_StartConvertToWord
 Start to convert a PDF file to a Word format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function. More...
 

Detailed Description

This class can be used to convert PDF files to Office(Word, Excel or PowerPoint) format files. Before using "Conversion" module, please ensure the resource folder named "res" in the PDF Conversion SDK package is valid. Before using methods in this module, please ensure Foxit PDF Conversion SDK has been initialized successfully by function FoxitPDFSDKPython2.Library.Initialize with a key including "PDF2Office" module.

See also
FoxitPDFSDKPython2.Library

Member Data Documentation

◆ Initialize

FoxitPDFSDKPython2.PDF2Office.Initialize = _fsdk.PDF2Office_Initialize
static

Initialize Foxit PDF Conversion SDK Library.

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

Parameters
[in]library_pathPath of PDF Conversion SDK library. This should not be an empty string.
Returns
None.

◆ Release

FoxitPDFSDKPython2.PDF2Office.Release = _fsdk.PDF2Office_Release
static

Release all resource allocated by Foxit PDF Conversion SDK Library.

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

Returns
None.

◆ StartConvertToExcel

FoxitPDFSDKPython2.PDF2Office.StartConvertToExcel = _fsdk.PDF2Office_StartConvertToExcel
static

Start to convert a PDF file to a Excel format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function.

Currently only support converting to XLSX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_excel_file_pathPath of the saved Excel format file as conversion result. This should not be an empty string. If the suffix name of the saved Excel format file is not "xlsx", a new suffix named "xlsx" will be added to the original file name.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.

Currently only support converting to XLSX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_excel_file_streamA FoxitPDFSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted Excel format file. It should not be null.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToPowerPoint

FoxitPDFSDKPython2.PDF2Office.StartConvertToPowerPoint = _fsdk.PDF2Office_StartConvertToPowerPoint
static

Start to convert a PDF file to a PowerPoint format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function.

Currently only support converting to PPTX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_ppt_file_pathPath of the saved PowerPoint format file as conversion result. This should not be an empty string. If the suffix name of the saved PowerPoint format file is not "pptx", a new suffix named "pptx" will be added to the original file name.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.

Currently only support converting to PPTX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_ppt_file_streamA FoxitPDFSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted PowerPoint format file. It should not be null.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToWord

FoxitPDFSDKPython2.PDF2Office.StartConvertToWord = _fsdk.PDF2Office_StartConvertToWord
static

Start to convert a PDF file to a Word format file. Function FoxitPDFSDKPython2.PDF2Office.Initialize must be called before calling this function.

Currently only support converting to DOCX format file.

Parameters
[in]src_pdf_pathPath of a PDF file. This should not be an empty string.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_word_file_pathPath of the saved Word format file as conversion result. This should not be an empty string. If the suffix name of the saved Word format file is not "docx", a new suffix named "docx" will be added to the original file name.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.

Currently only support converting to DOCX format file.

Parameters
[in]src_pdf_readerA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
[in]src_pdf_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_word_file_streamA FoxitPDFSDKPython2.StreamCallback object which is implemented by user to read the contents of the converted Word format file. It should not be null.
[in]setting_dataSetting data used for converting.
[in]convert_callbackA FoxitPDFSDKPython2.ConvertCallback object which is implemented by user to pause and notify the conversion progress during the converting process. This can be null which means not to pause and notify the conversion progress. If this is not null, it should be a valid FoxitPDFSDKPython2.ConvertCallback object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished..