|
Foxit PDF Conversion SDK
|
fpdfconversionsdk namespace. More...
Classes | |
| class | Base |
| class | ConvertCallback |
| class | ConvertCheckCallback |
| class | Excel2PDFSettingData |
| class | Library |
| class | Office2PDF |
| class | Office2PDFSettingData |
| class | PDF2ExcelSettingData |
| class | PDF2Office |
| class | PDF2OfficeSettingData |
| class | PDF2PowerPointSettingData |
| class | PDF2WordSettingData |
| class | Progressive |
| class | Range |
| class | Word2PDFSettingData |
| class | WStringArray |
Functions | |
| def | LibraryEnableThreadSafety () |
| Enable thread safety. More... | |
| def | LibraryGetVersion () |
| Get the version of current Foxit PDF Conversion SDK library. More... | |
| def | LibraryInitialize () |
| Initialize Foxit PDF Conversion SDK Library, with valid license information. More... | |
| def | LibraryReinitialize () |
| Re-initialize Foxit PDF Conversion SDK Library. More... | |
| def | LibraryRelease () |
| Release all resource allocated by Foxit PDF Conversion SDK Library. More... | |
| def | LibrarySetConvertCheckCallback () |
| Set the callback object to check the PDF to Office conversion conditions. More... | |
| def | Office2PDFConvertFromExcel () |
| Convert an Excel format file to a PDF file. More... | |
| def | Office2PDFConvertFromPowerPoint () |
| Convert a PowerPoint format file to a PDF file. More... | |
| def | Office2PDFConvertFromWord () |
| Convert a Word format file to a PDF file. More... | |
| def | PDF2OfficeStartConvertToExcel () |
| Start to convert a PDF file to a Excel format file. More... | |
| def | PDF2OfficeStartConvertToPowerPoint () |
| Start to convert a PDF file to a PowerPoint format file. More... | |
| def | PDF2OfficeStartConvertToWord () |
| Start to convert a PDF file to a Word format file. More... | |
Variables | |
| E_ErrCertificate | |
| Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate. | |
| E_ErrDataNotReady | |
| Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way. | |
| E_ErrFile | |
| File cannot be found or could not be opened. | |
| E_ErrFormat | |
| Format is invalid. For files, this may also mean that file is corrupted. | |
| E_ErrHandle | |
| Error handle. | |
| E_ErrInvalidLicense | |
| Invalid license is used to initialize Foxit PDF Conversion SDK library. | |
| E_ErrInvalidType | |
| The type of input object or current object is invalid. | |
| E_ErrNoDocumentPermission | |
| No document permission to operate. | |
| E_ErrNoOffice2PDFModuleRight | |
| No "Office2PDF" module right. | |
| E_ErrNoPDF2OfficeModuleRight | |
| No "PDF2Office" module right. | |
| E_ErrNotFound | |
| Expected data or object is not found. | |
| E_ErrNotLoaded | |
| Current object has not been loaded yet. | |
| E_ErrNotParsed | |
| Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet. | |
| E_ErrOutOfMemory | |
| Out-of-memory error occurs. | |
| E_ErrParam | |
| Parameter error: value of any input parameter for a function is invalid. | |
| E_ErrPassword | |
| Invalid password. Usually, this error may occur when loading a PDF document with password. When meet this, user should load document again with correct password. | |
| E_ErrSecurityHandler | |
| PDF document is encrypted by some unsupported security handler. | |
| E_ErrSuccess | |
| Success, and no error occurs. | |
| E_ErrUnknown | |
| Any unknown error occurs. | |
| E_ErrUnknownState | |
| Any unknown state occurs. | |
| E_ErrUnsupported | |
| Some types are not supported. | |
| E_PermAnnotForm | |
| Operate text annotations and fill in interactive form fields. (Bit 6 in permission value) More... | |
| E_PermAssemble | |
| Assemble PDF document. (Bit 11 in permission value) More... | |
| E_PermExtract | |
| Extract PDF contents. (Bit 5 in permission value) More... | |
| E_PermExtractAccess | |
| Disabilities support. (Bit 10 in permission value) More... | |
| E_PermFillForm | |
| Fill PDF form. (Bit 9 in permission value) More... | |
| E_PermModify | |
| Modify PDF contents. (Bit 4 in permission value) More... | |
| E_PermPrint | |
| Print PDF document with normal mode. (Bit 3 in permission value) More... | |
| E_PermPrintHigh | |
| Print PDF document with higher qualities. (Bit 12 in permission value) More... | |
| PDF2ExcelSettingDataE_WorkbookSettingsDocument | |
| Create single worksheet for the document. | |
| PDF2ExcelSettingDataE_WorkbookSettingsEachPage | |
| Create worksheet for each page. | |
| PDF2ExcelSettingDataE_WorkbookSettingsEachTable | |
| Create worksheet for each table. | |
| ProgressiveE_Error | |
| Progress state: any error occurs. | |
| ProgressiveE_Finished | |
| Progress state: progress is finished. | |
| ProgressiveE_ToBeContinued | |
| Progress state: progress needs to be continued. | |
| RangeE_All | |
| All the indexes within a range will be used. | |
| RangeE_Even | |
| Only even numbers in a range will be used (discards odd numbers). | |
| RangeE_Odd | |
| Only odd numbers in a range will be used (discards even numbers). | |
fpdfconversionsdk namespace.
| def fpdfconversionsdk.LibraryEnableThreadSafety | ( | ) |
Enable thread safety.
| [in] | is_enable_thread_safety | Enable thread safety.true means to enable thread safety, while false means to disable thread safety. |
| def fpdfconversionsdk.LibraryGetVersion | ( | ) |
Get the version of current Foxit PDF Conversion SDK library.
| def fpdfconversionsdk.LibraryInitialize | ( | ) |
Initialize Foxit PDF Conversion SDK Library, with valid license information.
During the life-cycle of an application, this function can only be called once and should be called first before any other functions in Foxit PDF Conversion SDK can be called.
Once function fpdfconversionsdk.LibraryRelease is called, Foxit PDF Conversion SDK library cannot be initialized any more in the life-cycle of the application.
| [in] | sn | String of sn information, which can be retrieved from "SN=" part in key file "gsdk_sn.txt" or "rdk_sn.txt". |
| [in] | key | String of key information, which can be retrieved from "Sign=" part in key file "gsdk_key.txt" or "rdk_key.txt". |
| def fpdfconversionsdk.LibraryReinitialize | ( | ) |
Re-initialize Foxit PDF Conversion SDK Library.
When user meets out-of-memory error or user wants to re-initialize Foxit PDF Conversion SDK library before function fpdfconversionsdk.LibraryRelease is called, user can call this function to re-initialize Foxit PDF Conversion SDK Library.
Once function fpdfconversionsdk.LibraryRelease is called, Foxit PDF Conversion SDK library cannot be initialized any more in the life-cycle of the application.
| def fpdfconversionsdk.LibraryRelease | ( | ) |
Release all resource allocated by Foxit PDF Conversion SDK Library.
User should call this function to release all memory blocks allocated by the library.
Once this fucntion is called, Foxit PDF Conversion SDK library cannot be initialized any more in the life-cycle of the application.
| def fpdfconversionsdk.LibrarySetConvertCheckCallback | ( | ) |
Set the callback object to check the PDF to Office conversion conditions.
This method allows you to specify a custom convert check callback that will be called to evaluate whether the conversion from PDF to Office should proceed, based on user-defined logic , when the required permissions for converting the PDF documents are not met.
| [in] | convert_check_callback | A customized convert check callback which is implemented based on callback class fpdfconversionsdk.ConvertCheckCallback . If this is null, customized convert check callback will be removed and default convert check will be used instead. |
| def fpdfconversionsdk.Office2PDFConvertFromExcel | ( | ) |
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.
| [in] | src_excel_file_path | Path 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_path | Path of the saved PDF file as conversion result. This should not be an empty string. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
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.
| [in] | src_excel_reader | A 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_stream | A fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
| def fpdfconversionsdk.Office2PDFConvertFromPowerPoint | ( | ) |
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.
| [in] | src_ppt_file_path | Path 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_path | Path of the saved PDF file as conversion result. This should not be an empty string. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
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.
| [in] | src_ppt_reader | A 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_stream | A fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
| def fpdfconversionsdk.Office2PDFConvertFromWord | ( | ) |
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.
| [in] | src_word_file_path | Path 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_path | Path of the saved PDF file as conversion result. This should not be an empty string. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
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.
| [in] | src_word_reader | A 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_stream | A fsdk.StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be null. |
| [in] | setting_data | A fpdfconversionsdk.Office2PDFSettingData object which is used for converting. |
| def fpdfconversionsdk.PDF2OfficeStartConvertToExcel | ( | ) |
Start to convert a PDF file to a Excel format file.
Currently only support converting to XLSX format file.
| [in] | src_pdf_path | Path of a PDF file. This should not be an empty string. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_excel_file_path | Path 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
Currently only support converting to XLSX format file.
| [in] | src_pdf_reader | A FileReaderCallback object which is implemented by user to load a PDF document. It should not be null. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_excel_file_stream | A 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
| def fpdfconversionsdk.PDF2OfficeStartConvertToPowerPoint | ( | ) |
Start to convert a PDF file to a PowerPoint format file.
Currently only support converting to PPTX format file.
| [in] | src_pdf_path | Path of a PDF file. This should not be an empty string. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_ppt_file_path | Path 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
Currently only support converting to PPTX format file.
| [in] | src_pdf_reader | A FileReaderCallback object which is implemented by user to load a PDF document. It should not be null. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_ppt_file_stream | A 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
| def fpdfconversionsdk.PDF2OfficeStartConvertToWord | ( | ) |
Start to convert a PDF file to a Word format file.
Currently only support converting to DOCX format file. This function supports the identification of headings in PDF documents and converts them into Word documents. Currently, the headings conversion is still in beta and will be further improved in subsequent versions.
| [in] | src_pdf_path | Path of a PDF file. This should not be an empty string. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_word_file_path | Path 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
Currently only support converting to DOCX format file. This function supports the identification of headings in PDF documents and converts them into Word documents. Currently, the headings conversion is still in beta and will be further improved in subsequent versions.
| [in] | src_pdf_reader | A FileReaderCallback object which is implemented by user to load a PDF document. It should not be null. |
| [in] | src_pdf_password | Password for the input PDF file. If no password is needed for the file, please pass an empty string. |
| [in] | saved_word_file_stream | A 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_data | Setting data used for converting.If the parameter page_range of PDF2OfficeSettingData object is empty, that means convert each page of the PDF file to Word format file. |
| [in] | convert_callback | A fpdfconversionsdk.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 fpdfconversionsdk.ConvertCallback object implemented by user. Default value: null. |
| fpdfconversionsdk.E_PermAnnotForm |
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
If value is also set, user can create or modify interactive form fields (including signature fields).
| fpdfconversionsdk.E_PermAssemble |
Assemble PDF document. (Bit 11 in permission value)
If this value is set, it enables to assemble the document (Insert, rotate, or delete pages and create bookmarks or thumbnail images), regardless if value is set or not.
| fpdfconversionsdk.E_PermExtract |
Extract PDF contents. (Bit 5 in permission value)
If this value is set, user can copy or otherwise extract text and graphics from the document by operations other than that controlled by value .
| fpdfconversionsdk.E_PermExtractAccess |
Disabilities support. (Bit 10 in permission value)
If this value is set, user can extract text and graphics in support of accessibility to users with disabilities or for other purposes.
| fpdfconversionsdk.E_PermFillForm |
Fill PDF form. (Bit 9 in permission value)
If this value is set, user can fill in interactive form fields (including signature fields), even if value is not used.
| fpdfconversionsdk.E_PermModify |
| fpdfconversionsdk.E_PermPrint |
Print PDF document with normal mode. (Bit 3 in permission value)
If user wants to print a higher quality level of PDF document, please set current value with value together.
| fpdfconversionsdk.E_PermPrintHigh |
Print PDF document with higher qualities. (Bit 12 in permission value)
If this value is not set (and value is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.