|
Foxit PDF SDK
|
Public Member Functions | |
| def | AddHeaderFooter (headerfooter) |
| Add new header-footer. More... | |
| def | AddIndirectObject (pdf_object) |
| Add a PDF object to current PDF document, to be an indirect object. More... | |
| def | AddPageFromTemplate (template_name) |
| Adds a new PDF page to document, from a named template. More... | |
| def | AddPagingSealSignature (page_range, width, height, to_check_permission) |
| Add a paging seal signature to document by page range. More... | |
| def | AddTableOfContents (title, bookmark_level_array) |
| Insert page(s) as the table of contents to the front of current PDF document. More... | |
| def | AddTableOfContents (table_of_contents_config) |
| Insert page(s) as the table of contents to the front of current PDF document. More... | |
| def | CheckPassword (password) |
| Check the type of a specified password. More... | |
| def | ClearRenderCache () |
| Clear the cache used during rendering, to reduce the memory usage. More... | |
| def | CreateDSS () |
| Create DSS information in current PDF document. More... | |
| def | CreateRootBookmark () |
| Create new bookmark root node. More... | |
| def | DeleteIndirectObject (object_number) |
| Delete an indirect object by indirect object number. More... | |
| def | DoJSOpenAction () |
| Perform JavaScript actions when the document is opened. More... | |
| def | ExportAnnotToFDF (pdf_annot, fdf_doc) |
| Export specified annotation to a FDF/XFDF document. More... | |
| def | ExportFormFieldsToFDF (field_array, is_include, fdf_doc) |
| Export specified form fields to a FDF/XFDF document. More... | |
| def | ExportToFDF (fdf_doc, types, page_range) |
| Export form fields and annotations to a FDF/XFDF document. More... | |
| def | GetAllPageBasicInfo () |
| Get the basic information of all page. More... | |
| def | GetAnnotsByIdArray (unique_id_arr) |
| Get annotations by the unique ID array. More... | |
| def | GetBookmarkLevelDepth () |
| Get bookmark level depth. More... | |
| def | GetCatalog () |
| Get the catalog dictionary. More... | |
| def | GetCertificateEncryptData () |
| Get encrypt data of certificate encryption. More... | |
| def | GetCustomEncryptData () |
| Get encrypt data of custom encryption. More... | |
| def | GetDisplayMode () |
| Get the display mode. More... | |
| def | GetDRMEncryptData () |
| Get encrypt data of Foxit DRM encryption. More... | |
| def | GetEditableHeaderFooter () |
| Get the editable header footer object. More... | |
| def | GetEmbeddedFontData () |
| Get embedded font data. More... | |
| def | GetEncryptDict () |
| Get the encrypt dictionary. More... | |
| def | GetEncryptionType () |
| Get the encryption type. More... | |
| def | GetFileSize () |
| Get file size. More... | |
| def | GetFileVersion () |
| Get PDF file version stored in PDF header section. More... | |
| def | GetFirstAvailPageIndex () |
| Get the page index of the fist available page. More... | |
| def | GetFont (index) |
| Get a font by index. More... | |
| def | GetFontCount () |
| Count all the PDF fonts used in current PDF document. More... | |
| def | GetHeader () |
| Get PDF header identifying the version of the PDF specification to which the file conforms. More... | |
| def | GetIndirectObject (object_number) |
| Get an indirect object by indirect object number. More... | |
| def | GetInfo () |
| Get the information dictionary. More... | |
| def | GetOpenAction () |
| Get the action to be performed when the document is opened. More... | |
| def | GetPage (index) |
| Get a PDF page by index. More... | |
| def | GetPageBasicInfo (index) |
| Get the basic information of a page specified by index. More... | |
| def | GetPageCount () |
| Get the count of pages. More... | |
| def | GetPagesDict () |
| Get the dictionary of "Pages". More... | |
| def | GetPageText (page_index) |
| Get the specified PDF page text which the text is in display order. More... | |
| def | GetPasswordType () |
| Get the type of current used password. More... | |
| def | GetPayLoadData () |
| Get payload data if current document's wrapper type is fsdk.PDFDocE_WrapperPDFV2 . More... | |
| def | GetReadingBookmark (index) |
| Get a reading bookmark by index. More... | |
| def | GetReadingBookmarkCount () |
| Get the count of reading bookmarks. More... | |
| def | GetRMSEncryptData () |
| Get encrypt data of RMS encryption. More... | |
| def | GetRootBookmark () |
| Get bookmark root node. More... | |
| def | GetSecurityHandler () |
| Get current PDF security handler of current document. More... | |
| def | GetSignature (index) |
| Get a signature by index. More... | |
| def | GetSignatureCount () |
| Get the count of signature. More... | |
| def | GetStdEncryptData () |
| Get encrypt data of standard encryption (known as password encryption). More... | |
| def | GetTrailer () |
| Get the trailer dictionary. More... | |
| def | GetUserPassword (owner_password) |
| Get the user password based on owner password. More... | |
| def | GetUserPermissions () |
| Get user access permissions. More... | |
| def | GetWrapperData () |
| Get wrapper data if current document's wrapper type is fsdk.PDFDocE_WrapperFoxit . More... | |
| def | GetWrapperOffset () |
| Get wrapper offset if current document's wrapper type is fsdk.PDFDocE_WrapperFoxit . More... | |
| def | GetWrapperType () |
| Get Wrapper type. More... | |
| def | HasForm () |
| Check whether current PDF document has interactive form (also known as AcroForm). More... | |
| def | HasHeaderFooter () |
| Check whether current document has header-footer. More... | |
| def | HasLayer () |
| Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1.7>) or not. More... | |
| def | HidePageTemplate (template_name) |
| Hide a named page. More... | |
| def | ImportFromFDF (fdf_doc, types, page_range) |
| Import form fields and annotations from a FDF/XFDF document. More... | |
| def | InsertDocument (dest_index, src_doc, options) |
| Insert another PDF document to the specified location of current PDF document. More... | |
| def | InsertDocument (dest_index, src_doc, options, bookmark_title) |
| Insert another PDF document to the specified location of current PDF document. More... | |
| def | InsertPage (index, width, height) |
| Insert a new blank PDF page to document, by index. More... | |
| def | InsertPage (index, size) |
| Insert a new blank PDF page to document, by index. More... | |
| def | InsertReadingBookmark (reading_bookmark_index, title, dest_page_index) |
| Insert a reading bookmark to current PDF document. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | IsEncrypted () |
| Check whether current document is an encrypted file or not. More... | |
| def | IsLinearized () |
| Check if current PDF document is a linearized file. More... | |
| def | IsOwnerPassword (password) |
| Check if input password is the owner password of current PDF document. More... | |
| def | IsPortfolio () |
| Check whether current PDF document is a portfolio file or not. More... | |
| def | IsTaggedPDF () |
| Check if current PDF document is a Tagged PDF file. More... | |
| def | IsUserPassword (password) |
| Check if input password is the user password of current PDF document. More... | |
| def | IsWrapper () |
| Check whether current document is a wrapper file or not. More... | |
| def | IsXFA () |
| Check whether current PDF document is an XFA document. More... | |
| def | Load (password) |
| Load current document content by using a specified password. More... | |
| def | LoadW (password) |
| Load current document content by using a specified password. More... | |
| def | MovePagesTo (page_range, dest_index) |
| Move one or more pages (specified by index) to a new index position. More... | |
| def | MovePageTo (page, dest_index) |
| Move a specified page to a new index position. More... | |
| def | RemoveAllHeaderFooters () |
| Remove all header-footers. More... | |
| def | RemoveBookmark (bookmark) |
| Remove a specified bookmark. More... | |
| def | RemoveHiddenInfo (hidden_data_setting) |
| Removes specified types of hidden information from the current PDF document based on user-defined settings. More... | |
| def | RemoveOpenAction () |
| Remove the action to be performed when the document is opened. More... | |
| def | RemovePage (index) |
| Remove a PDF page by page index. More... | |
| def | RemovePage (page) |
| Remove a specified PDF page. More... | |
| def | RemoveReadingBookmark (reading_bookmark) |
| Remove a reading bookmark from current PDF document. More... | |
| def | RemoveSecurity () |
| Remove the security handler from current document, so that the later saved document will be unencrypted. More... | |
| def | RemoveSignature (signature) |
| Remove a signature. More... | |
| def | Sanitize () |
| Removes all hidden or potentially sensitive information from the current PDF document using default settings. More... | |
| def | SaveAs (file_path, save_flags) |
| Save current PDF document as another PDF file. More... | |
| def | SaveAsWrapperFile (file_path, wrapper_data, user_permissions, owner_password) |
| Save current PDF document as a wrapper file. More... | |
| def | SetCacheFile (file_stream, is_own_file_stream) |
| Set cache file (represented by a file stream) to current PDF document. More... | |
| def | SetDisplayMode (display_mode) |
| Set the display mode. More... | |
| def | SetFileVersion (version) |
| Set the PDF file version which will be stored in PDF header section of the saved PDF file. More... | |
| def | SetOpenAction (action) |
| Set the action to be performed when the document is opened. More... | |
| def | SetSecurityHandler (handler) |
| Set a PDF security handler for encryption, such as standard encryption(password), certificate encryption, and so on. More... | |
| def | StartAddTiledWatermark (text, settings, properties, page_range, pause) |
| Add text type tiled watermark to PDF pages. More... | |
| def | StartEmbedAllFonts (pause) |
| Start to convert all un-embeded fonts to embeded fonts. More... | |
| def | StartExtractPages (file_path, options, page_range, pause) |
| Start to extract pages from current PDF document. More... | |
| def | StartExtractPages (file, options, page_range, pause) |
| Start to extract pages from current PDF document. More... | |
| def | StartGetPayloadFile (payload_file, pause) |
| Start to get payload file. More... | |
| def | StartImportPages (dest_index, src_doc, flags, layer_name, page_range, pause) |
| Start to import pages from another PDF document (via PDF document object). More... | |
| def | StartImportPagesFromFilePath (dest_index, src_file_path, password, flags, layer_name, page_range, pause) |
| Start to import pages from another PDF document (via file path). More... | |
| def | StartLoad (password, is_cache_stream, pause) |
| Start to loading current document content by using a specified password. More... | |
| def | StartLoadW (password, is_cache_stream, pause) |
| Start to loading current document content by using a specified password. More... | |
| def | StartRecognizeForm (pause) |
| Start to recognize form in current PDF document. More... | |
| def | StartRecognizeForm (is_set_tool_tips, pause) |
| Start to recognize form in current PDF document. More... | |
| def | StartSaveAs (file_path, save_flags, pause) |
| Start to save current PDF document as another PDF file. More... | |
| def | StartSaveAs (file, save_flags, pause) |
| Start to save current PDF document as another PDF file. More... | |
| def | StartSaveAsPayloadFile (file_path, payload_file_path, crypto_filter, description, version, save_flags, pause) |
| Start to save current PDF document as a wrapper document with a payload document (defined in PDF 2.0). More... | |
| def | UpdateHeaderFooter (headerfooter) |
| Update header-footer. More... | |
A PDF document object can be constructed with an existing PDF file from file path, memory buffer, a custom implemented fsdk.FileReaderCallback object and an input file stream. And then call function fsdk.PDFDoc.Load or fsdk.PDFDoc.StartLoad to load document content. This class offers functions to retrieve different part of a PDF document. For example:
To retrieve pages, please use functions fsdk.PDFDoc.GetPageCount and fsdk.PDFDoc.GetPage .
To retrieve bookmark, such as function fsdk.PDFDoc.GetRootBookmark , fsdk.PDFDoc.CreateRootBookmark , etc.
To retrieve some document's dictionaries (in low-level), such as functions fsdk.PDFDoc.GetCatalog , fsdk.PDFDoc.GetTrailer , etc.
To retrieve reading bookmark, such as functions fsdk.PDFDoc.GetReadingBookmarkCount , fsdk.PDFDoc.GetReadingBookmark , etc.
To check if a PDF document has interactive form, please use function fsdk.PDFDoc.HasForm .
To check if a PDF document has header-footer, please use function fsdk.PDFDoc.HasHeaderFooter . To modify header-footer, please refer to functions such as fsdk.PDFDoc.AddHeaderFooter , fsdk.PDFDoc.UpdateHeaderFooter , and fsdk.PDFDoc.RemoveAllHeaderFooters .
This class also offers functions for features, such as saving current document as another PDF file, importing pages from another PDF file, setting security handler in order to save encrypted PDF file, and so on.
This class object can also be used to construct objects of other classes in order to access specified information in PDF document:
To access form, please construct a fsdk.Form object with PDF document object.
To access additional actions, please construct an fsdk.AdditionalAction object with PDF document object.
To access viewer preferences information, please construct a DocViewerPrefs object with PDF document object.
To access metadata information, please construct a Metadata object with PDF document object.
To manage page labels information, please construct a PageLabels object with PDF document object.
To search among a PDF file, please construct a TextSearch object with PDF document object.
To access layers, please construct a LayerTree object with PDF document object. And to render layers, please constructor a LayerContext object with PDF document object.
To construct a new FileSpec object.
To manage associated files, please construct an AssociatedFiles object with PDF document object.
To access name tree, please construct a fsdk.PDFNameTree object with PDF document object. Specially, for EmbeddedFiles name tree, an Attachments object can be constructed with PDF document object, for convenient use.
To do redaction, please construct a fsdk.Redaction object with PDF document object.
| def fsdk.PDFDoc.AddHeaderFooter | ( | headerfooter | ) |
Add new header-footer.
A PDF document can be added header-footer sereral times. When a new header-footer is added, the old ones will not be removed but be covered by the new one if the old ones appear in the same place as new one.
| [in] | headerfooter | A valid header-footer object to be added to current document. |
| def fsdk.PDFDoc.AddIndirectObject | ( | pdf_object | ) |
Add a PDF object to current PDF document, to be an indirect object.
If input PDF object is a direct object (whose indirect object number is 0), this functions will change it to be an indirect object and add to PDF document. Then return the new indirect object number.
If input PDF object is already an indirect object (whose indirect object number is above 0), this function will not add it into document again. The return value will be its own indirect object number.
| [in] | pdf_object | A fsdk.PDFObject object. It should not be null. |
| def fsdk.PDFDoc.AddPageFromTemplate | ( | template_name | ) |
Adds a new PDF page to document, from a named template.
There may exist hidden pages in a PDF document. Hidden pages are mapped to the names defined in the template name tree in the PDF document. This function can be used to add a hidden page to the end of the PDF document.
Class fsdk.PDFNameTree (initialized with type fsdk.PDFNameTreeE_Templates ) can be used to determine which template names are available.
After a template has been added, the name will be moved to the document's pages name tree internally.
| [in] | template_name | The name of a template, whose mapping hidden page will be added to the end of current PDF document. If the template name cannot be found, exception fsdk.E_ErrParam will be thrown. |
| def fsdk.PDFDoc.AddPagingSealSignature | ( | page_range, | |
| width, | |||
| height, | |||
| to_check_permission | |||
| ) |
Add a paging seal signature to document by page range.
This function will add a signature to the first page of page_range.
| [in] | page_range | A range object that specifies some pages. These pages will be added a signature. The valid page range: from 1 to count. count is returned by function fsdk.PDFDoc.GetPageCount . If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be added a signature. This function does not support a range with a single index or a document with a single page. |
| [in] | width | The width of paging seal. The value will be used for setting rectangle of the signature on each page. |
| [in] | height | The height of paging seal. The value will be used for setting rectangle of the signature on each page. |
| [in] | to_check_permission | A boolean value to decide whether Foxit PDF SDK should check PDF document's permission before adding signature: true means Foxit PDF SDK should check document permission to decide if adding signature is allowed, while false means Foxit PDF SDK should not check document permission before adding signature. When this parameter is false, user should ensure to check document permission to check if adding signature is allowed. Default value: true. |
| def fsdk.PDFDoc.AddTableOfContents | ( | title, | |
| bookmark_level_array | |||
| ) |
Insert page(s) as the table of contents to the front of current PDF document.
If the current document does not have any bookmark, this function will do nothing.
| [in] | title | Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used. |
| [in] | bookmark_level_array | A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". For each element in input array, valid range: from 1 to (depth). depth is returned by function fsdk.PDFDoc.GetBookmarkLevelDepth . If input array is an empty array, that means all bookmarks are used to generate "Table of Contents". |
| def fsdk.PDFDoc.AddTableOfContents | ( | table_of_contents_config | ) |
Insert page(s) as the table of contents to the front of current PDF document.
If the current document does not have any bookmark, this function will do nothing.
| [in] | table_of_contents_config | A table of contents configuration object which is used for the table of contents. |
| def fsdk.PDFDoc.CheckPassword | ( | password | ) |
Check the type of a specified password.
This function can be used to check the type of any password string, including the password string used for loading document content.
Some PDF documents may have user password and owner password at the same time and these two passwords are same. But current function can only return one type for such password. In this case, functions fsdk.PDFDoc.IsUserPassword and fsdk.PDFDoc.IsOwnerPassword can help to do more check.
| [in] | password | A password string to be detected. |
| def fsdk.PDFDoc.ClearRenderCache | ( | ) |
Clear the cache used during rendering, to reduce the memory usage.
| def fsdk.PDFDoc.CreateDSS | ( | ) |
Create DSS information in current PDF document.
If current PDF document already has DSS information, this function will do nothing and return directly.
| def fsdk.PDFDoc.CreateRootBookmark | ( | ) |
Create new bookmark root node.
If current PDF document already has the bookmark root node, this function will remove the old bookmark tree and create a new root node instead.
| def fsdk.PDFDoc.DeleteIndirectObject | ( | object_number | ) |
Delete an indirect object by indirect object number.
| [in] | object_number | The indirect object number. It should be above 0. |
| def fsdk.PDFDoc.DoJSOpenAction | ( | ) |
Perform JavaScript actions when the document is opened.
| def fsdk.PDFDoc.ExportAnnotToFDF | ( | pdf_annot, | |
| fdf_doc | |||
| ) |
Export specified annotation to a FDF/XFDF document.
| [in] | pdf_annot | A valid PDF annotation object to be exported to the FDF/XFDF document. |
| [in] | fdf_doc | A valid FDF/XFDF document object, to which the specified annotation will be exported. |
| def fsdk.PDFDoc.ExportFormFieldsToFDF | ( | field_array, | |
| is_include, | |||
| fdf_doc | |||
| ) |
Export specified form fields to a FDF/XFDF document.
| [in] | field_array | An array of form fields. Parameter is_include will decide whether data of these form fields are to exported or not. |
| [in] | is_include | A boolean value used to decide whether data of specified form fields are to be exported or not: true means data of specified form fields are to be exported, while false means data of specified form fields are not to be exported. |
| [in] | fdf_doc | A valid FDF/XFDF document object, to which the specified form fields will be exported. |
| def fsdk.PDFDoc.ExportToFDF | ( | fdf_doc, | |
| types, | |||
| page_range | |||
| ) |
Export form fields and annotations to a FDF/XFDF document.
For more details about the type of PDF object available for exporting, please refer to Page 22 of "XML Forms Data Format Specification".
| [in] | fdf_doc | A valid FDF/XFDF document object, to which form fields and annotations will be exported. |
| [in] | types | Used to decide which kind of data will be exported. Please refer to values starting from fsdk.PDFDocE_Forms and this can be one or a combination of these values. Default value: (fsdk.PDFDocE_Forms | fsdk.PDFDocE_Annots ). |
| [in] | page_range | A range object that specifies some pages. Data (in specified types) in these pages will be exported to FDF/XFDF document. If this range object is constructed by default constructor and not set any value, that means all the data (in specified types) of current document will be exported to FDF/XFDF document. This parameter is only useful when parameter types contains fsdk.PDFDocE_Annots . Default value: a range object by default constructor and not set any value. |
| def fsdk.PDFDoc.GetAllPageBasicInfo | ( | ) |
Get the basic information of all page.
This function can quickly get the basic information of a PDF page without getting that PDF page object. If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may throw exception fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| def fsdk.PDFDoc.GetAnnotsByIdArray | ( | unique_id_arr | ) |
Get annotations by the unique ID array.
| [in] | unique_id_arr | The array of unique ID. The unique ID is renturned by function fsdk.Annot.GetUniqueID . |
| def fsdk.PDFDoc.GetBookmarkLevelDepth | ( | ) |
Get bookmark level depth.
| def fsdk.PDFDoc.GetCatalog | ( | ) |
Get the catalog dictionary.
| def fsdk.PDFDoc.GetCertificateEncryptData | ( | ) |
Get encrypt data of certificate encryption.
This function is useful when current document is encrypted by certificate.
| def fsdk.PDFDoc.GetCustomEncryptData | ( | ) |
Get encrypt data of custom encryption.
This function is useful when current document is encrypted by custom.
| def fsdk.PDFDoc.GetDisplayMode | ( | ) |
Get the display mode.
Display mode specifies how the document should be displayed when opened.
| def fsdk.PDFDoc.GetDRMEncryptData | ( | ) |
Get encrypt data of Foxit DRM encryption.
This function is useful when current document is encrypted by Foxit DRM.
| def fsdk.PDFDoc.GetEditableHeaderFooter | ( | ) |
Get the editable header footer object.
A PDF document may have been added header-footer sereral times, but only one of these header-footer can be editable. This function is to retreive the editable header-footer.
| def fsdk.PDFDoc.GetEmbeddedFontData | ( | ) |
Get embedded font data.
This function is used for unembbeding font in "Optimizer" model.
| def fsdk.PDFDoc.GetEncryptDict | ( | ) |
Get the encrypt dictionary.
| def fsdk.PDFDoc.GetEncryptionType | ( | ) |
Get the encryption type.
| def fsdk.PDFDoc.GetFileSize | ( | ) |
Get file size.
| def fsdk.PDFDoc.GetFileVersion | ( | ) |
Get PDF file version stored in PDF header section.
| def fsdk.PDFDoc.GetFirstAvailPageIndex | ( | ) |
Get the page index of the fist available page.
This is useful for a linearized PDF document because in a linearized PDF document the first available page may not be the first page.
This function can be used only when document is loaded successfully.
| def fsdk.PDFDoc.GetFont | ( | index | ) |
Get a font by index.
| [in] | index | The index of PDF font. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetFontCount . |
| def fsdk.PDFDoc.GetFontCount | ( | ) |
Count all the PDF fonts used in current PDF document.
This function will enumerate all the font resources used for pages, annotations, and interactive form.
| def fsdk.PDFDoc.GetHeader | ( | ) |
Get PDF header identifying the version of the PDF specification to which the file conforms.
| def fsdk.PDFDoc.GetIndirectObject | ( | object_number | ) |
Get an indirect object by indirect object number.
| [in] | object_number | The indirect object number. It should be above 0. |
| def fsdk.PDFDoc.GetInfo | ( | ) |
Get the information dictionary.
Document's information dictionary contains metadata for the document.
| def fsdk.PDFDoc.GetOpenAction | ( | ) |
Get the action to be performed when the document is opened.
| def fsdk.PDFDoc.GetPage | ( | index | ) |
Get a PDF page by index.
If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may throw exception fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| [in] | index | The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . |
| def fsdk.PDFDoc.GetPageBasicInfo | ( | index | ) |
Get the basic information of a page specified by index.
This function can quickly get the basic information of a PDF page without getting that PDF page object. If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may throw exception fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| [in] | index | The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . |
| def fsdk.PDFDoc.GetPageCount | ( | ) |
Get the count of pages.
| def fsdk.PDFDoc.GetPagesDict | ( | ) |
Get the dictionary of "Pages".
| def fsdk.PDFDoc.GetPageText | ( | page_index | ) |
Get the specified PDF page text which the text is in display order.
| [in] | page_index | The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . |
| def fsdk.PDFDoc.GetPasswordType | ( | ) |
Get the type of current used password.
This function is useful after loading a PDF document, in order to get the type of the password which was used in the loading process.
If current document is a new one (not loading from existed PDF file), this function will return fsdk.PDFDocE_PwdNoPassword .
If current document is constructed from an existing file but has not been loaded yet, this function will return fsdk.PDFDocE_PwdInvalid .
| def fsdk.PDFDoc.GetPayLoadData | ( | ) |
Get payload data if current document's wrapper type is fsdk.PDFDocE_WrapperPDFV2 .
| def fsdk.PDFDoc.GetReadingBookmark | ( | index | ) |
Get a reading bookmark by index.
| [in] | index | The index of reading bookmarks. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetReadingBookmarkCount . |
| def fsdk.PDFDoc.GetReadingBookmarkCount | ( | ) |
Get the count of reading bookmarks.
| def fsdk.PDFDoc.GetRMSEncryptData | ( | ) |
Get encrypt data of RMS encryption.
This function is useful when current document is encrypted by RMS.
| def fsdk.PDFDoc.GetRootBookmark | ( | ) |
Get bookmark root node.
| def fsdk.PDFDoc.GetSecurityHandler | ( | ) |
Get current PDF security handler of current document.
| def fsdk.PDFDoc.GetSignature | ( | index | ) |
Get a signature by index.
| [in] | index | The index of signature. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetSignatureCount . |
| def fsdk.PDFDoc.GetSignatureCount | ( | ) |
Get the count of signature.
| def fsdk.PDFDoc.GetStdEncryptData | ( | ) |
Get encrypt data of standard encryption (known as password encryption).
This function is useful when current document is encrypted by password.
| def fsdk.PDFDoc.GetTrailer | ( | ) |
Get the trailer dictionary.
| def fsdk.PDFDoc.GetUserPassword | ( | owner_password | ) |
Get the user password based on owner password.
This function is useful when current document is encrypted by password.
| [in] | owner_password | Owner password string. |
| def fsdk.PDFDoc.GetUserPermissions | ( | ) |
Get user access permissions.
| def fsdk.PDFDoc.GetWrapperData | ( | ) |
Get wrapper data if current document's wrapper type is fsdk.PDFDocE_WrapperFoxit .
| def fsdk.PDFDoc.GetWrapperOffset | ( | ) |
Get wrapper offset if current document's wrapper type is fsdk.PDFDocE_WrapperFoxit .
| def fsdk.PDFDoc.GetWrapperType | ( | ) |
Get Wrapper type.
| def fsdk.PDFDoc.HasForm | ( | ) |
Check whether current PDF document has interactive form (also known as AcroForm).
If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may throw exception fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| def fsdk.PDFDoc.HasHeaderFooter | ( | ) |
Check whether current document has header-footer.
| def fsdk.PDFDoc.HasLayer | ( | ) |
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1.7>) or not.
| def fsdk.PDFDoc.HidePageTemplate | ( | template_name | ) |
Hide a named page.
Pages in a PDF document can be mapped to names defined in the pages name tree in the PDF document. This function can be used to hide these named pages.
Class fsdk.PDFNameTree (initialized with type fsdk.PDFNameTreeE_Pages ) can be used to determine which page names are available and to map pages to names.
After a PDF page has been hidden, the name will be moved to the document's templates name tree internally.
| [in] | template_name | The name of a PDF page to be hidden. |
| def fsdk.PDFDoc.ImportFromFDF | ( | fdf_doc, | |
| types, | |||
| page_range | |||
| ) |
Import form fields and annotations from a FDF/XFDF document.
It also supports to import form fields in FDF template. The page associated with the FDF template will be inserted into the end of document. For more details about the type of PDF object available for exporting, please refer to Page 22 of "XML Forms Data Format Specification".
| [in] | fdf_doc | A valid FDF/XFDF document object, from which form fields and annotations will be imported. |
| [in] | types | Used to decide which kind of data will be imported. Please refer to values starting from fsdk.PDFDocE_Forms and this can be one or a combination of these values. Default value: (fsdk.PDFDocE_Forms | fsdk.PDFDocE_Annots ). It does not work if fdf_doc is the fdf template. |
| [in] | page_range | A range object that specifies some pages. Data (in specified types) from FDF/XFDF document will be imported to these specified pages. If this range object is constructed by default constructor and not set any value, that means data (in specified types) from FDF/XFDF document will be imported to related PDF pages whose index have been defined in FDF/XFDF document. This parameter is only useful when parameter types contains fsdk.PDFDocE_Annots . Default value: a range object by default constructor and not set any value. It does not work if fdf_doc is the fdf template. |
| def fsdk.PDFDoc.InsertDocument | ( | dest_index, | |
| src_doc, | |||
| options | |||
| ) |
Insert another PDF document to the specified location of current PDF document.
| [in] | dest_index | A page index in current PDF document. This is used to specify where to insert the pages from src_doc: If parameter dest_index is less than 0, these pages will be inserted to the first. If parameter dest_index is equal to or larger than current page count, these pages will be inserted to the end. |
| [in] | src_doc | A PDF document object which represents the PDF document to be inserted to current PDF document. All the pages in this document will be inserted to current PDF document. Please keep this source PDF document object valid until current document will not be saved any more or is closed. |
| [in] | options | Options for inserting a PDF document. Please refer to values starting from fsdk.PDFDocE_InsertDocOptionAttachments and this can be one or a combination of these values. 0 means no option is used. |
| def fsdk.PDFDoc.InsertDocument | ( | dest_index, | |
| src_doc, | |||
| options, | |||
| bookmark_title | |||
| ) |
Insert another PDF document to the specified location of current PDF document.
| [in] | dest_index | A page index in current PDF document. This is used to specify where to insert the pages from src_doc: If parameter dest_index is less than 0, these pages will be inserted to the first. If parameter dest_index is equal to or larger than current page count, these pages will be inserted to the end. |
| [in] | src_doc | A PDF document object which represents the PDF document to be inserted to current PDF document. All the pages in this document will be inserted to current PDF document. Please keep this source PDF document object valid until current document will not be saved any more or is closed. |
| [in] | options | Options for inserting a PDF document. Please refer to values starting from fsdk.PDFDocE_InsertDocOptionAttachments and this can be one or a combination of these values. 0 means no option is used. |
| [in] | bookmark_title | The title of the bookmark. Default value: InsertBookMark. |
| def fsdk.PDFDoc.InsertPage | ( | index, | |
| width, | |||
| height | |||
| ) |
Insert a new blank PDF page to document, by index.
| [in] | index | The page index for new page. If parameter index is less than 0, the new page will be inserted to the first. If parameter index is equal to or larger than current page count, the new page will be inserted to the end. |
| [in] | width | Width of new page (unit is 1/72 inch). |
| [in] | height | Height of new page (unit is 1/72 inch). |
| def fsdk.PDFDoc.InsertPage | ( | index, | |
| size | |||
| ) |
Insert a new blank PDF page to document, by index.
| [in] | index | The page index for new page. If parameter index is less than 0, the new page will be inserted to the first. If parameter index is equal to or larger than current page count, the new page will be inserted to the end. |
| [in] | size | Size type of new page. Please refer to values starting from fsdk.PDFPageE_SizeLetter and this should be one of these values. Default value: fsdk.PDFPageE_SizeLetter . |
| def fsdk.PDFDoc.InsertReadingBookmark | ( | reading_bookmark_index, | |
| title, | |||
| dest_page_index | |||
| ) |
Insert a reading bookmark to current PDF document.
| [in] | reading_bookmark_index | A reading bookmark index. If reading_bookmark_index is less than 0, the new reading bookmark will be inserted to the first. If reading_bookmark_index is equal to or larger than the count of reading bookmarks, the new reading bookmark will be inserted to the end. |
| [in] | title | Title string for new reading bookmark and should not an empty string. |
| [in] | dest_page_index | The index of destination page. |
| def fsdk.PDFDoc.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.PDFDoc.IsEncrypted | ( | ) |
Check whether current document is an encrypted file or not.
| def fsdk.PDFDoc.IsLinearized | ( | ) |
Check if current PDF document is a linearized file.
If current document object is constructed with an fsdk.AsyncReaderCallback object, this function can be used before or after the document is loaded successfully. Specially, if this function is called before document is loaded successfully, application should ensure the first 1024 bytes of the PDF file is available; otherwise, this function will call the callback function fsdk.AsyncReaderCallback.AddDownloadHint to notify application the range of data which should be downloaded by application then, and then this function will throw exception fsdk.E_ErrDataNotReady .
If current document object is constructed from other methods or with a common fsdk.FileReaderCallback object, this function can only be used after the document is loaded successfully; otherwise, exception fsdk.E_ErrUnknownState will be thrown.
| def fsdk.PDFDoc.IsOwnerPassword | ( | password | ) |
Check if input password is the owner password of current PDF document.
| [in] | password | A password string to be detected. |
| def fsdk.PDFDoc.IsPortfolio | ( | ) |
Check whether current PDF document is a portfolio file or not.
| def fsdk.PDFDoc.IsTaggedPDF | ( | ) |
Check if current PDF document is a Tagged PDF file.
A Tagged PDF means there is structure tree in the PDF document.
| def fsdk.PDFDoc.IsUserPassword | ( | password | ) |
Check if input password is the user password of current PDF document.
| [in] | password | A password string to be detected. |
| def fsdk.PDFDoc.IsWrapper | ( | ) |
Check whether current document is a wrapper file or not.
| def fsdk.PDFDoc.IsXFA | ( | ) |
Check whether current PDF document is an XFA document.
Currently, Foxit PDF SDK does not fully support XFA document. When loading an XFA document, Foxit PDF SDK may only load the XFA wrapper level, and cannot have access to the real XFA content. Foxit PDF SDK does not support to insert/import/remove/move pages in an XFA document yet.
| def fsdk.PDFDoc.Load | ( | password | ) |
Load current document content by using a specified password.
If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may return fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| [in] | password | The password string, used to load current document content. The password can be either user password or owner password. If current document is not encrypted by password, just pass an empty string. Default value: an empty string. |
| def fsdk.PDFDoc.LoadW | ( | password | ) |
Load current document content by using a specified password.
If current PDF document object is constructed with an AsyncReaderCallback which means to do asynchronous loading, this function may return fsdk.E_ErrDataNotReady . In this case, user should prepare data for specified range informed by callback function fsdk.AsyncReaderCallback.AddDownloadHint and then call this function again.
| [in] | password | The password string, used to load current document content. The password can be either user password or owner password. If current document is not encrypted by password, just pass an empty string. Default value: an empty string. |
| def fsdk.PDFDoc.MovePagesTo | ( | page_range, | |
| dest_index | |||
| ) |
Move one or more pages (specified by index) to a new index position.
If move only one page, this function just has the same feature as function fsdk.PDFDoc.MovePageTo .
If move more than one page, these page will keep the order defined in parameter page_range and be moved to the destination index position as a whole.
After this function is successful, indexes of moved pages will be changed and indexes of the rest pages may be affected as well.
| [in] | page_range | A range object which should at least contain one valid range. All the related pages will keep the order (specified by this range) and be moved as a whole. If there exist duplicated indexes in the range, only the last occurrence will be useful. |
| [in] | dest_index | Index of the destination position, based on current page array. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . |
| def fsdk.PDFDoc.MovePageTo | ( | page, | |
| dest_index | |||
| ) |
Move a specified page to a new index position.
If the specified page is successfully moved to the new index position, page index of all the pages between the new index and old index of the specified page will be changed as well.
| [in] | page | A PDF page to be moved. It should be in current PDF document. |
| [in] | dest_index | Index of the destination position in page array. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . If parameter dest_index is just the same as the page index of parameter page, no change will be done and this function will return true directly. |
| def fsdk.PDFDoc.RemoveAllHeaderFooters | ( | ) |
Remove all header-footers.
| def fsdk.PDFDoc.RemoveBookmark | ( | bookmark | ) |
Remove a specified bookmark.
| [in] | bookmark | The valid bookmark that would be deleted. |
| def fsdk.PDFDoc.RemoveHiddenInfo | ( | hidden_data_setting | ) |
Removes specified types of hidden information from the current PDF document based on user-defined settings.
This method provides fine-grained control over the sanitization process. Only the data types enabled in the provided settings object will be removed. It allows selective removal of elements such as metadata, bookmarks, hidden text, layers, comments, links, and more.
| [in] | hidden_data_setting | A HiddenInfoSettingData object that defines which types of hidden data to remove. |
| def fsdk.PDFDoc.RemoveOpenAction | ( | ) |
Remove the action to be performed when the document is opened.
| def fsdk.PDFDoc.RemovePage | ( | index | ) |
Remove a PDF page by page index.
| [in] | index | The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount . |
| def fsdk.PDFDoc.RemovePage | ( | page | ) |
Remove a specified PDF page.
Once the specified PDF page is removed successfully, the page object cannot be used any more.
| [in] | page | A PDF page object that represents the PDF page to be removed. The page should be in current PDF document. |
| def fsdk.PDFDoc.RemoveReadingBookmark | ( | reading_bookmark | ) |
Remove a reading bookmark from current PDF document.
| [in] | reading_bookmark | A valid reading bookmark to be removed. |
| def fsdk.PDFDoc.RemoveSecurity | ( | ) |
Remove the security handler from current document, so that the later saved document will be unencrypted.
| def fsdk.PDFDoc.RemoveSignature | ( | signature | ) |
Remove a signature.
| [in] | signature | A valid signature to be removed. If this signature's type is fsdk.SignatureE_SignatureTypePagingSeal , this function will remove all signatures related to this signature. |
| def fsdk.PDFDoc.Sanitize | ( | ) |
Removes all hidden or potentially sensitive information from the current PDF document using default settings.
This method performs a full sanitization of the PDF document. It automatically detects and removes metadata, comments, hidden text, file attachments, annotations, and other elements that may contain hidden or private information.
| def fsdk.PDFDoc.SaveAs | ( | file_path, | |
| save_flags | |||
| ) |
Save current PDF document as another PDF file.
If current document is loaded from an existing PDF file and a different file version has been set by fsdk.PDFDoc.SetFileVersion before saving, Foxit PDF SDK will ignore fsdk.PDFDocE_SaveFlagIncremental in parameter save_flags and use the file version in saved PDF file.
| [in] | file_path | A full path for the new saved PDF file. It should not be an empty string. |
| [in] | save_flags | Document saving flags. Please refer to values starting from fsdk.PDFDocE_SaveFlagNormal and this can be one or combination of these values. Default value: fsdk.PDFDocE_SaveFlagNormal . |
Use current function to save current PDF object to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that current PDF object has destructed – which is equal to "close document".
Remove "org.pdf" and rename "temp.tmp" to "org.pdf".
| def fsdk.PDFDoc.SaveAsWrapperFile | ( | file_path, | |
| wrapper_data, | |||
| user_permissions, | |||
| owner_password | |||
| ) |
Save current PDF document as a wrapper file.
PDF wrapper is an extended standard, and it helps to hint some information to viewers.
PDF wrapper consists of
wrapper type: it is an identity string,
wrapper offset: it tells the end of original data,
wrapper template: it is the content of wrapper document.
This function uses the current size of file which is specified by file_path to set wrapper offset.
| [in] | file_path | A full path of a PDF file. Current PDF document will be saved into this PDF file as a wrapper file. |
| [in] | wrapper_data | Wrapper data. If this is null, no wrapper data is used. Default value: null. |
| [in] | user_permissions | User permissions for the wrapper document. Pass 0xFFFFFFFC if no special permissions is needed. Please refer to values starting from fsdk.PDFDocE_PermPrint and this should be one or combination of these values. Default value: 0xFFFFFFFC. |
| [in] | owner_password | Owner password. If this is an empty string, parameter user_permissions will be ignored. Default value: an empty string. |
| def fsdk.PDFDoc.SetCacheFile | ( | file_stream, | |
| is_own_file_stream | |||
| ) |
Set cache file (represented by a file stream) to current PDF document.
Cache file can be used to cache the large amount of data which are generated when the content stream is generated.
| [in] | file_stream | A fsdk.StreamCallback object which is implemented by user to cache data. It can be null. The origin cache file will be released if it is null. |
| [in] | is_own_file_stream | Used to decide whether Foxit PDF SDK should own input stream callback object or not: true means input stream callback object will be destroyed by Foxit PDF SDK (by calling callback function StreamCallback::Release ) when no need to cache data anymore for current PDF document. false means user should be responsible to destroy the stream callback object when no need to modify any content of current PDF document. |
| def fsdk.PDFDoc.SetDisplayMode | ( | display_mode | ) |
Set the display mode.
Display mode specifies how the document should be displayed when opened.
| [in] | display_mode | Display mode value. Please refer to values starting from fsdk.PDFDocE_DisplayUseNone and this should be one of these values. |
| def fsdk.PDFDoc.SetFileVersion | ( | version | ) |
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
The new file version will not affect on current document directly, but will be used in the saved PDF file in function fsdk.PDFDoc.SaveAs or fsdk.PDFDoc.StartSaveAs . This function does not check whether the PDF content matches the specified version.
If user wants to do compliance conversion about PDF version, please refer to module "Compliance" and use class addon::compliance::PDFCompliance.
| [in] | version | An integer that specifies the file version, for example value 14 means version "1.4", value 15 means "1.5", and etc. This value should be from 10 to 17 or 20 and be equal or greater than current version of current PDF file. |
| def fsdk.PDFDoc.SetOpenAction | ( | action | ) |
Set the action to be performed when the document is opened.
| [in] | action | A valid action to be set. Currently only support following types as the new action: fsdk.ActionE_TypeGoto , fsdk.ActionE_TypeURI , fsdk.ActionE_TypeJavaScript , fsdk.ActionE_TypeNamed , fsdk.ActionE_TypeSubmitForm , fsdk.ActionE_TypeResetForm , fsdk.ActionE_TypeHide , fsdk.ActionE_TypeImportData . |
| def fsdk.PDFDoc.SetSecurityHandler | ( | handler | ) |
Set a PDF security handler for encryption, such as standard encryption(password), certificate encryption, and so on.
| [in] | handler | A PDF security handler object. |
| def fsdk.PDFDoc.StartAddTiledWatermark | ( | text, | |
| settings, | |||
| properties, | |||
| page_range, | |||
| pause | |||
| ) |
Add text type tiled watermark to PDF pages.
Add page type tiled watermark to PDF pages.
Add image type tiled watermark to PDF pages by image stream.
Add image type tiled watermark to PDF pages by image path.
If the watermark is tiled to multiple pages, these pages will keep the order defined in the parameter page_range. If the parameter page_range is initialized to empty, the watermark will be tiled to all pages of the document by default. In addition, XFA dynamic documents don't support inserting tiled watermarks.
| [in] | text | A text string. This will be used as the content of the tiled watermark, It should not be an empty string. |
| [in] | settings | Tiled watermark settings, containing layout setting. |
| [in] | properties | Text properties for tiled watermark. |
| [in] | page_range | A range object that specifies some pages. These pages will be added tiled watermarks. The valid page range: from 0 to (count -1). count is returned by function fsdk.PDFDoc.GetPageCount . If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be added tiled watermarks. |
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
If the watermark is tiled to multiple pages, these pages will keep the order defined in the parameter page_range. If the parameter page_range is initialized to empty, the watermark will be tiled to all pages of the document by default. In addition, XFA dynamic documents don't support inserting tiled watermarks.
Image tiled watermarks support .bmp .dib .jpg .jpeg .jpe .gif .png .tif .tiff format.
| [in] | src_img_file_path | Path of a image file. This should not be an empty string. |
| [in] | settings | Tiled watermark settings, containing layout setting. |
| [in] | page_range | A range object that specifies some pages. These pages will be added tiled watermarks. The valid page range: from 0 to (count -1). count is returned by function fsdk.PDFDoc.GetPageCount . If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be added tiled watermarks. |
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
If the watermark is tiled to multiple pages, these pages will keep the order defined in the parameter page_range. If the parameter page_range is initialized to empty, the watermark will be tiled to all pages of the document by default. In addition, XFA dynamic documents don't support inserting tiled watermark.
Image tiled watermarks support .bmp .dib .jpg .jpeg .jpe .gif .png .tif .tiff format.
| [in] | src_img_stream | A fsdk.FileReaderCallback object which is image stream by user to pass image data to Foxit PDF SDK. It must be vaild. |
| [in] | settings | Tiled watermark settings, containing layout setting. |
| [in] | page_range | A range object that specifies some pages. These pages will be added tiled watermarks. The valid page range: from 0 to (count -1). count is returned by function fsdk.PDFDoc.GetPageCount . If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be added tiled watermarks. |
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
If the watermark is tiled to multiple pages, these pages will keep the order defined in the parameter page_range. If the parameter page_range is initialized to empty, the watermark will be tiled to all pages of the document by default. In addition, XFA dynamic documents don't support inserting tiled watermarks.
| [in] | page | A valid PDF page object, whose content will be used as the content of the tiled watermark. |
| [in] | settings | Tiled watermark settings, containing layout setting. |
| [in] | page_range | A range object that specifies some pages. These pages will be added tiled watermarks. The valid page range: from 0 to (count -1). count is returned by function fsdk.PDFDoc.GetPageCount . If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be added tiled watermarks. |
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartEmbedAllFonts | ( | pause | ) |
Start to convert all un-embeded fonts to embeded fonts.
It may take a long time to convert all un-embedded fonts to embedded fonts in current PDF document, so this function uses a progressive process to do this.
This function only works with fonts available for embedding. Whether a font is embeddable or not can be checked by function fsdk.Font.IsSupportEmbedded .
This function will delete the original font object after embedding the font, however, the reference to the original font in the document will still exist.
| [in] | pause | Pause callback object which decides if the embedding process needs to be paused. This can be null which means not to pause during the embedding process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartExtractPages | ( | file_path, | |
| options, | |||
| page_range, | |||
| pause | |||
| ) |
Start to extract pages from current PDF document.
It may take a long time to extracting pages, so Foxit PDF SDK uses a progressive process to do this.
| [in] | file_path | A full path for the new saved PDF file which is used to save the extracted pages. It should not be an empty string. |
| [in] | options | Options for extracting pages. Please refer to values starting from fsdk.PDFDocE_ExtractPagesOptionAnnotation and this can be one or a combination of these values. 0 means no option is used. |
| [in] | page_range | A range object to specify which pages are to be extracted. If this range object is constructed by default constructor and not set any value, all pages in the current document will be extracted. Default value: a range object by default constructor and not set any value. |
| [in] | pause | Pause object which decides if the extracting process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartExtractPages | ( | file, | |
| options, | |||
| page_range, | |||
| pause | |||
| ) |
Start to extract pages from current PDF document.
It may take a long time to extracting pages, so Foxit PDF SDK uses a progressive process to do this.
| [in] | file | A fsdk.FileWriterCallback object which is implemented by user to store the data of all the extracted pages in custom method. |
| [in] | options | Options for extracting pages. Please refer to values starting from fsdk.PDFDocE_ExtractPagesOptionAnnotation and this can be one or a combination of these values. 0 means no option is used. |
| [in] | page_range | A range object to specify which pages are to be extracted. If this range object is constructed by default constructor and not set any value, all pages in the current document will be extracted. Default value: a range object by default constructor and not set any value. |
| [in] | pause | Pause object which decides if the extracting process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartGetPayloadFile | ( | payload_file, | |
| pause | |||
| ) |
Start to get payload file.
It may take a long time to getting payload document, so this function uses a progressive process to do this.
| [in] | payload_file | A WriterCallback callback object. User should implement the callback function in this callback object in order that this callback object can be used to save payload file. |
| [in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartImportPages | ( | dest_index, | |
| src_doc, | |||
| flags, | |||
| layer_name, | |||
| page_range, | |||
| pause | |||
| ) |
Start to import pages from another PDF document (via PDF document object).
It may take a long time to importing pages, so Foxit PDF SDK uses a progressive process to do this.
Signed signatures in the pages of source PDF document will not be imported into current PDF document.
Currently, if either current PDF document or the source PDF document contains XFA, not support to do the importing.
If this function is used to combine two PDF files, pages are strongly recommended to be imported to the end of destination PDF file instead of to the beginning of destination PDF file.
| [in] | dest_index | A page index in current PDF document. This is used to specify where the imported pages will be inserted: If parameter dest_index is less than 0, the imported pages will be inserted to the first. If parameter dest_index is equal to or larger than current page count, the imported pages will be inserted to the end. |
| [in] | src_doc | A PDF document object which is the source PDF document. Pages in this document will be imported to current PDF document. Please keep this source PDF document object valid until current document will not be saved any more or is closed. |
| [in] | flags | Options for importing pages. Please refer to values starting from fsdk.PDFDocE_ImportFlagNormal and this can be one or a combination of these values. Default value: fsdk.PDFDocE_ImportFlagNormal . |
| [in] | layer_name | The name of non-selectable label or the prefix name of the non-selectable label to be shown in layer panel of application. Default value: an empty string. If parameter flags contains fsdk.PDFDocE_ImportFlagWithLayers , this should not be empty and should be a valid string. If parameter flags does not contain fsdk.PDFDocE_ImportFlagWithLayers , this string will be ignored.
|
| [in] | page_range | A range object to specify which pages is to be inserted. If this range object is constructed by default constructor and not set any value, all pages in the source document will be imported. Default value: a range object by default constructor and not set any value. |
| [in] | pause | Pause object which decides if the importing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartImportPagesFromFilePath | ( | dest_index, | |
| src_file_path, | |||
| password, | |||
| flags, | |||
| layer_name, | |||
| page_range, | |||
| pause | |||
| ) |
Start to import pages from another PDF document (via file path).
It may take a long time to importing pages, so Foxit PDF SDK uses a progressive process to do this.
Signed signatures in the pages of source PDF document will not be imported into current PDF document.
Currently, Foxit PDF SDK does not support to do the importing if either current PDF document or the source PDF document contains XFA.
If this function is used to combine two PDF files, pages are strongly recommended to be imported to the end of destination PDF file instead of to the beginning of destination PDF file.
| [in] | dest_index | A page index in current PDF document. This is used to specify where the imported pages will be inserted. If parameter dest_index is less than 0, the imported pages will be inserted to the first. If parameter dest_index is equal to or larger than current page count, the imported pages will be inserted to the end. |
| [in] | src_file_path | A full path of an existing PDF file as the source PDF document. Some pages will be imported from this PDF file to current PDF document. |
| [in] | password | A password string used to load source PDF document content. The password can be either user password or owner password. If source PDF document is not encrypted by password, just pass an empty string. |
| [in] | flags | Options for importing pages. Please refer to values starting from fsdk.PDFDocE_ImportFlagNormal and this can be one or a combination of these values. Default value: fsdk.PDFDocE_ImportFlagNormal . |
| [in] | layer_name | The name of non-selectable label or the prefix name of the non-selectable label to be shown in layer panel of application. Default value: an empty string. If parameter flags contains fsdk.PDFDocE_ImportFlagWithLayers , this should not be empty and should be a valid string. If parameter flags does not contain fsdk.PDFDocE_ImportFlagWithLayers , this string will be ignored.
|
| [in] | page_range | A range object to specify which pages is to be imported. If this range object is constructed by default constructor and not set any value, all pages in the source document will be imported. Default value: a range object by default constructor and not set any value. |
| [in] | pause | Pause object which decides if the importing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartLoad | ( | password, | |
| is_cache_stream, | |||
| pause | |||
| ) |
Start to loading current document content by using a specified password.
It may take a long time to loading document content, so this function uses a progressive process to do this.
When using this function, parameter is_cache_stream can be used to decide whether to load stream content into memory or not:
Loading stream content into memory will improve performance for frequent access, however, it will also consume a lot of memory space.
Not to load stream content into memory, that means to leave stream content on file system, and read them when needed. This may reduce the performance a little bit, but greatly reduce the memory consumption, especially when the file is big.
| [in] | password | A password string, used to load current document content. The password can be either user password or owner password. If current document is not encrypted by password, just pass an empty string. Default value: an empty string. |
| [in] | is_cache_stream | true means to load stream content into memory, and false means not to load stream content into memory and just leave stream content on file system and read them when needed. Please refer to "Details" part about the difference between these two modes. Default value: true. |
| [in] | pause | Pause object which decides if the loading process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartLoadW | ( | password, | |
| is_cache_stream, | |||
| pause | |||
| ) |
Start to loading current document content by using a specified password.
It may take a long time to loading document content, so this function uses a progressive process to do this.
When using this function, parameter is_cache_stream can be used to decide whether to load stream content into memory or not:
Loading stream content into memory will improve performance for frequent access, however, it will also consume a lot of memory space.
Not to load stream content into memory, that means to leave stream content on file system, and read them when needed. This may reduce the performance a little bit, but greatly reduce the memory consumption, especially when the file is big.
| [in] | password | A password string, used to load current document content. The password can be either user password or owner password. If current document is not encrypted by password, just pass an empty string. Default value: an empty string. |
| [in] | is_cache_stream | true means to load stream content into memory, and false means not to load stream content into memory and just leave stream content on file system and read them when needed. Please refer to "Details" part about the difference between these two modes. Default value: true. |
| [in] | pause | Pause object which decides if the loading process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartRecognizeForm | ( | pause | ) |
Start to recognize form in current PDF document.
It may take a long time to recognize form in PDF document, so this function uses a progressive process to do this.
For windows platform, users are strongly recommended to initialize OCR engine by calling function addon::ocr::OCREngine::Initialize before calling this function.
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartRecognizeForm | ( | is_set_tool_tips, | |
| pause | |||
| ) |
Start to recognize form in current PDF document.
It may take a long time to recognize form in PDF document, so this function uses a progressive process to do this.
For windows platform, users are strongly recommended to initialize OCR engine by calling function addon::ocr::OCREngine::Initialize before calling this function.
| [in] | is_set_tool_tips | true means to set tool tips for recognized form field, while false means not to set tool tips for recognized form field. |
| [in] | pause | Pause callback object which decides if the recognizing process needs to be paused. This can be null which means not to pause during the recognizing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.StartSaveAs | ( | file_path, | |
| save_flags, | |||
| pause | |||
| ) |
Start to save current PDF document as another PDF file.
It may take a long time to saving PDF document, so this function uses a progressive process to do this.
If current document is loaded from an existing PDF file and a different file version has been set by fsdk.PDFDoc.SetFileVersion before saving, Foxit PDF SDK will ignore fsdk.PDFDocE_SaveFlagIncremental in parameter save_flags and use the file version in saved PDF file.
| [in] | file_path | A full path for the new saved PDF file. It should not be an empty string. |
| [in] | save_flags | Document saving flags. Please refer to values starting from fsdk.PDFDocE_SaveFlagNormal and this can be one or combination of these values. Default value: fsdk.PDFDocE_SaveFlagNormal . |
| [in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
Use current function to save current PDF object to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that current PDF object has destructed – which is equal to "close document".
Remove "org.pdf" and rename "temp.tmp" to "org.pdf".
| def fsdk.PDFDoc.StartSaveAs | ( | file, | |
| save_flags, | |||
| pause | |||
| ) |
Start to save current PDF document as another PDF file.
It may take a long time to saving PDF document, so this function uses a progressive process to do this.
If current document is loaded from an existing PDF file and a different file version has been set by fsdk.PDFDoc.SetFileVersion before saving, Foxit PDF SDK will ignore fsdk.PDFDocE_SaveFlagIncremental in parameter save_flags and use the file version in saved PDF file.
| [in] | file | A fsdk.FileWriterCallback object which is implemented by user to save a PDF document. |
| [in] | save_flags | Document saving flags. Please refer to values starting from fsdk.PDFDocE_SaveFlagNormal and this can be one or combination of these values. Default value: fsdk.PDFDocE_SaveFlagNormal . |
| [in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
Use current function to save current PDF object to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that current PDF object has destructed – which is equal to "close document".
Remove "org.pdf" and rename "temp.tmp" to "org.pdf".
| def fsdk.PDFDoc.StartSaveAsPayloadFile | ( | file_path, | |
| payload_file_path, | |||
| crypto_filter, | |||
| description, | |||
| version, | |||
| save_flags, | |||
| pause | |||
| ) |
Start to save current PDF document as a wrapper document with a payload document (defined in PDF 2.0).
It may take a long time to saving PDF document, so this function uses a progressive process to do this.
If current document is loaded from an existing PDF file and a different file version has been set by fsdk.PDFDoc.SetFileVersion before saving, Foxit PDF SDK will ignore fsdk.PDFDocE_SaveFlagIncremental in parameter save_flags and use the file version in saved PDF file.
| [in] | file_path | A full path for the new saved PDF file. It should not be an empty string. |
| [in] | payload_file_path | A full path of a PDF document which will be used as payload document. It should not be an empty string. |
| [in] | crypto_filter | The name of the cryptographic filter used to encrypt the encrypted payload document. |
| [in] | description | Description for wrapper file to show applications or confront users prompt information. |
| [in] | version | The version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary. |
| [in] | save_flags | Document saving flags. Please refer to values starting from fsdk.PDFDocE_SaveFlagNormal and this can be one or combination of these values. Default value: fsdk.PDFDocE_SaveFlagNormal . |
| [in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |
| def fsdk.PDFDoc.UpdateHeaderFooter | ( | headerfooter | ) |
Update header-footer.
A PDF document can be added header-footer sereral times. When a header-footer is updated to the document, the old ones which appear in the same place with the new one will all be removed and then the new one will be added.
| [in] | headerfooter | A valid header-footer object to be updated to current document. |