Foxit PDF SDK
FSDK.PDF2Office Class Reference

Public Member Functions

 Release ()
 Release all resource allocated by Foxit PDF Conversion SDK Library. More...
 

Static Public Member Functions

static Initialize (library_path)
 Initialize Foxit PDF Conversion SDK Library. More...
 
static StartConvertToExcel (src_pdf_path, src_pdf_password, saved_excel_file_path, setting_data, convert_callback)
 Start to convert a PDF file to a Excel format file. Function FSDK.Initialize must be called before calling this function. More...
 
static StartConvertToExcel (src_pdf_reader, src_pdf_password, saved_excel_file_stream, setting_data, convert_callback)
 Start to convert a PDF file to a Excel format file. Function FSDK.Initialize must be called before calling this function. More...
 
static StartConvertToPowerPoint (src_pdf_path, src_pdf_password, saved_ppt_file_path, setting_data, convert_callback)
 Start to convert a PDF file to a PowerPoint format file. Function FSDK.Initialize must be called before calling this function. More...
 
static StartConvertToPowerPoint (src_pdf_reader, src_pdf_password, saved_ppt_file_stream, setting_data, convert_callback)
 Start to convert a PDF file to a PowerPoint format file. Function FSDK.Initialize must be called before calling this function. More...
 
static StartConvertToWord (src_pdf_path, src_pdf_password, saved_word_file_path, setting_data, convert_callback)
 Start to convert a PDF file to a Word format file. Function FSDK.Initialize must be called before calling this function. More...
 
static StartConvertToWord (src_pdf_reader, src_pdf_password, saved_word_file_stream, setting_data, convert_callback)
 Start to convert a PDF file to a Word format file. Function FSDK.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 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 FSDK.Library.Initialize with a key including "PDF2Office" module.

See also
FSDK.Library

Member Function Documentation

◆ Initialize()

static FSDK.PDF2Office.Initialize ( library_path  )
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 Foxit PDF Conversion SDK library. This should not be an empty string.
Returns
None.

◆ Release()

FSDK.PDF2Office.Release ( )

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() [1/2]

static FSDK.PDF2Office.StartConvertToExcel ( src_pdf_path  ,
src_pdf_password  ,
saved_excel_file_path  ,
setting_data  ,
convert_callback   
)
static

Start to convert a PDF file to a Excel format file. Function FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToExcel() [2/2]

static FSDK.PDF2Office.StartConvertToExcel ( src_pdf_reader  ,
src_pdf_password  ,
saved_excel_file_stream  ,
setting_data  ,
convert_callback   
)
static

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

Currently only support converting to XLSX format file.

Parameters
[in]src_pdf_readerA FSDK.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 FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToPowerPoint() [1/2]

static FSDK.PDF2Office.StartConvertToPowerPoint ( src_pdf_path  ,
src_pdf_password  ,
saved_ppt_file_path  ,
setting_data  ,
convert_callback   
)
static

Start to convert a PDF file to a PowerPoint format file. Function FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToPowerPoint() [2/2]

static FSDK.PDF2Office.StartConvertToPowerPoint ( src_pdf_reader  ,
src_pdf_password  ,
saved_ppt_file_stream  ,
setting_data  ,
convert_callback   
)
static

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

Currently only support converting to PPTX format file.

Parameters
[in]src_pdf_readerA FSDK.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 FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToWord() [1/2]

static FSDK.PDF2Office.StartConvertToWord ( src_pdf_path  ,
src_pdf_password  ,
saved_word_file_path  ,
setting_data  ,
convert_callback   
)
static

Start to convert a PDF file to a Word format file. Function FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ StartConvertToWord() [2/2]

static FSDK.PDF2Office.StartConvertToWord ( src_pdf_reader  ,
src_pdf_password  ,
saved_word_file_stream  ,
setting_data  ,
convert_callback   
)
static

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

Currently only support converting to DOCX format file.

Parameters
[in]src_pdf_readerA FSDK.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 FSDK.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.If the parameter page_range of FSDK.PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file.
[in]convert_callbackA FSDK.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 FSDK.ConvertCallback object implemented by user.
Default value: null.
Returns
A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished..