PDFDoc

Triggered after printing a document

Triggered after saving a document

Triggered before closing a document

Triggered before printing a document

Triggered before saving a document

flatten all

flatten only annots

flatten only forms

flatten only links

insert bookmark

do not insert bookmark

Default constructor. Creates an empty new document.

Create a PDF document from an existing SDF/Cos document.

Note: the SDFDoc will become invalid. If you would like to access the low level document use GetSDFDoc

Open an existing PDF document.

Note: Make sure to call InitSecurityHandler() after PDFDoc(...) in case a document is encrypted

Open an existing PDF document.

Note: if the input stream doesn't support Seek() operation the document will load whole data stream in memory before parsing. In case of linearized PDF, the document may be parsed on-the-fly while it is being loaded in memory. Note that since StdFile implements Seek() interface, the document does not have to be fully in memory before it is used.

Note: Make sure to call InitSecurityHandler() after PDFDoc(...) for encrypted documents.

Open a SDF/Cos document from a memory buffer.

Note: the document should be fully loaded in the memory buffer.

Open an existing PDF document from an InputStream.

Note: Make sure to call InitSecurityHandler() after FDFDoc(...) for encrypted documents.

Open an existing PDF document from an InputStream.

Note: Make sure to call InitSecurityHandler() after FDFDoc(...) for encrypted documents.

Associates a file attachment with the document. The file attachment will be displayed in the user interface of a viewer application (in Acrobat this is File Attachment tab). The function differs from Annot.CreateFileAttachment() because it associates the attachment with the whole document instead of an annotation on a specific page.

Note: Another way to associate a file attachment with the document is using SDF::NameTree: {@code SDF.NameTree names = SDF.NameTree.Create(doc, "EmbeddedFiles"); names.put(file_key, file_keysz, embedded_file.GetSDFObj());

AddHighlights is used to highlight text in a document using 'Adobe's Highlight File Format' (Technical Note #5172 ). The method will parse the character offset data and modify the current document by adding new highlight annotations.

Adds/links the specified Bookmark to the root level of document's outline tree.

Adds a signature handler to the signature manager. There can only be one signature handler of a given name that can exist in the signature manager. A signature handler which name already exists in the signature manager cannot be added.

Adds a standard (built-in) signature handler to the signature manager. This method will use cryptographic algorithm based on Adobe.PPKLite/adbe.pkcs7.detached filter to sign a PDF.

Adds a standard (built-in) signature handler to the signature manager. This method will use cryptographic algorithm based on Adobe.PPKLite/adbe.pkcs7.detached filter to sign a PDF.

Imports two external PDFs and highlights the differences between them. This function appends alternating pages from the two input documents into the current document. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Imports two external PDFs and highlights the differences between them. This function appends alternating pages from the two input documents into the current document. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Imports two external pages and highlights the differences between them. This function adds two new pages to the current document. The two input pages are typically coming from two different PDF files. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Generates a PDF diff of the given pages by overlaying and blending them on top of each other, then appends that diff as a new page in this document.

Destructor. Close PDFDoc.

Creates an unsigned digital signature form field inside the document.

Create the indirect array.

Create the indirect boolean.

Create the indirect dictionary

Create SDF/Cos indirect name Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects they can be shared).

Create the indirect null.

Create the indirect number.

Create the indirect stream.

Create the indirect stream.

Create the indirect stream.

Create the indirect stream.

Create the indirect string from buffer

Create the indirect string.

Extract form data and/or annotations to FDF

Extract annotations to FDF

Extract form data and/or annotations to FDF

Extract form data to FDF

Extract annotations to FDF

Extract annotations to FDF

Import form data from FDF file to PDF interactive form.

Replace existing form and annotation data with those imported from the FDF file. It will make annotations in the FDF match those in the PDF. Since this method avoids updating annotations unnecessarily it works well with incremental save and can sometimes preserve annotation appearances, but it requires that the annotations intended to be in the final document be in the provided FDF file.

Note: Some PDF viewers (like Chrome) cannot display annotations that don't already have an appearance, so it is often desirable to call PDFDoc.RefreshAnnotAppearances after this method to ensure these annotations can still be displayed in those applications.

Note: This method is not suitable for realtime collaboration.

Create a new interactive form field

Create a new interactive form field

Create a new interactive form Field.

Create a new interactive form field

Create a new interactive form field

Flatten all annotations in the document.

Flatten all annotations in the document.

Flatten annotations/forms/links in the document.

Generates thumbnail images for all the pages in this PDF document.

Get the AcroForm Dictionary.

Retrieves an iterator that iterates over digital signature fields.

Retrieves the most restrictive document permissions locking level from all of the signed digital signatures in the document.

Get the document infomation

Returns the number of bytes that have been downloaded, when `hasDownloader()` is True.

Get the specified field from field name

Get specified FieldIterator from field name

An interactive form (sometimes referred to as an AcroForm) is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document. The following methods are used to access and manipulate Interactive form fields (sometimes referred to as AcroForms).

Get the file name.

Get the first bookmark.

Get the optional group configuration

Get the optional content groups

Get the open action.

Note: if the document does not nave associated action the returned Action will be null (i.e. Action.IsValid() returns false)

Get the page object from given page number

Get the page count.

Get the page iterator from given page number

Get the page iterator.

Get the specified page label

Get the pages.

Get the root of the document

Get the underlying SDFDoc object.

Get the security handler.

Note: InitSecurityHandler() should be called before GetSecurityHandler() in order to initialize the handler.

Note: Returned security handler can be modified in order to change the security settings of the existing document. Changes to the current handler will not invalidate the access to the original file and will take effect during document Save().

Note: If the security handler is modified, document will perform a full save even if INCREMENTAL was given in Save() method.

Gets the associated signature handler instance from the signature manager by looking it up with the handler name. The returned signature handler instance is still owned by the signature manage if found.

Get the structure tree root

Returns the document's total size in bytes, when `HasDownloader()` is True.

Get the document's trailer.

Get the Action associated with the selected PDFDoc Trigger event.

Get the view preferences

Call this function to determine whether the document has been modified since the last Undo/Redo snapshot was taken

Indicates whether this document was created via the `PDFViewCtrl` method `OpenURLAsync`.

Checks for optional content

Checks whether or not the underlying file has an XRef table that had to be repaired when the file was opened. If the document had an invalid XRef table when opened, PDFNet will have repaired the XRef table for its working representation of the document. Note: If this function returns true, it is not possible to incrementally save the document (see http://www.pdftron.com/kb_corrupt_xref)

Indicates whether this documents contains any digital signatures.

Highlights the differences between the external PDFs. The highlights are added directly to the inputs. This function directly adds the highlights to the two input documents. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Import given pages into current PDFDoc

The function imports a list of pages to this documents. Although a list of pages can be imported using repeated calls to PageInsert(), PageImport will not import duplicate copies of resources that are shared across pages (such as fonts, images, colorspaces etc). Therefore this method is recommended when a page import list consists of several pages that share the same resources.

Initialize the security handler.

Initializes document's SecurityHandler. This version of InitSecurityHandler() works with Standard and Custom PDF security and can be used in situations where the password is obtained dynamically via user feedback. See EncTest sample for example code. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized it can be later obtained using GetSecurityHandler() method.

Initializes document's SecurityHandler using the supplied password. This version of InitSecurityHandler() assumes that document uses Standard security and that a password is specified directly. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized, it can be later obtained using GetSecurityHandler() method.

Initializes document's SecurityHandler using the supplied password. This version of InitSecurityHandler() assumes that document uses Standard security and that a password is specified directly. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized, it can be later obtained using GetSecurityHandler() method.

Initializes the JS context.

Inserts a range of pages from specified PDFDoc

Inserts a range of pages from specified PDFDoc using PageSet

Checks if PDFDoc is encrypted.

Call this function to determine whether the document is represented in linearized (fast web view) format.

Note: Any changes to the document can invalidate linearization. The function will return 'true' only if the original document is linearized and if it is not modified.

In order to provide good performance over relatively slow communication links, PDFNet can generate PDF documents with linearized objects and hint tables that can allow a PDF viewer application to download and view one page of a PDF file at a time, rather than requiring the entire file (including fonts and images) to be downloaded before any of it can be viewed.

To save a document in linearized (fast web view) format you only need to pass LINEARIZED mode in the Save. method.

Call this function to determine whether the document has been modified since it was last saved.

Checks if current document is tagged.

Locks the document to prevent competing threads from accessiong the document at the same time. Threads attempting to access the document will wait in suspended state until the thread that owns the lock calls doc.Unlock().

Locks the document to prevent competing write threads (using lock()) from accessing the document at the same time. Other reader threads however, will be allowed to access the document. Threads attempting to obtain write access to the document will wait in suspended state until the thread that owns the lock calls doc.unlockRead(). Note: To avoid deadlocks obtaining a write lock while holding a read lock is not permitted and will throw an exception. If this situation is encountered please either unlock the read lock before the write lock is obtained or acquire a write lock (rather than read lock) in the first place.

Import form data from XFDF contents into this PDF.

Merge existing form and annotation data with those imported from the XFDF file. It will replace annotations from pdfdocument with matching annotations from XFDF. In order for the annotations to be considered matching, "name" of the xfdf annotation needs to match "NM" of that in pdf. XFDF annotations that don't have a match in the pdf document will be added. For regular xfdf files, no deletions will be made This method also supports command form of xfdf, for those files, deletions will be performed for annotations in "delete" section Since this method avoids updating annotations unnecessarily it works well with incremental save. Note: This method is suitable for realtime collaboration.

Merge existing form and annotation data with those imported from the XFDF file. It will replace annotations from pdfdocument with matching annotations from XFDF. In order for the annotations to be considered matching, "name" of the xfdf annotation needs to match "NM" of that in pdf. XFDF annotations that don't have a match in the pdf document will be added. For regular xfdf files, no deletions will be made This method also supports command form of xfdf, for those files, deletions will be performed for annotations in "delete" section Since this method avoids updating annotations unnecessarily it works well with incremental save. Note: This method is suitable for realtime collaboration.

Import form data from XFDF contents into this PDF.

Moves a range of pages from specified PDFDoc. Pages are deleted from source document after move.

Note: MovePages function does not save sourceDoc. It merely delete pages in memory. For permanent changes, PDFDoc::Save should be used to save sourceDoc after function exists.

Moves a range of pages from specified PDFDoc. Pages are deleted from source document after move.

Note: MovePages function does not save sourceDoc. It merely delete pages in memory. For permanent changes, PDFDoc::Save should be used to save sourceDoc after function exists.

Create page with given media box

Create a new, empty page in the document. You can use PageWriter to fill the page with new content. Finally the page should be inserted at specific place within document page sequence using PageInsert/PagePushFront/PagePushBack methods.

Note: the new page still does not belong to document page sequence and should be subsequently placed at a specific location within the sequence.

Insert/Import a single page at a specific location in the page sequence.

Note: Invalidates all PageIterators pointing to the document.

Adds a page to the end of a documents's page sequence.

Note: Invalidates all PageIterators pointing to the document.

Adds a page to the beginning of a documents's page sequence.

Remove specified page

Generates the appearance stream for annotations in the document using the specified options. A common use case is to generate appearances only for missing annotations, which can be accomplished using the default options.

Generates the appearance stream for annotations in the document using the default options. A common use case is to generate appearances only for missing annotations, which can be accomplished using the default options.

Regenerates the appearance stream for every widget annotation in the document Call this method if you modified field's value and would like to update field's appearances.

Removes the page label that is attached to the specified page, effectively merging the specified range with the previous page label sequence.

Removes all security for the document.

Removes a signature handler from the signature manager.

Saves the document to an OutputStream. See save(OutputStream, SDFDoc.SaveMode, ProgressMonitor)

Saves the document to a memory buffer. See save(SDFDoc.SaveMode, ProgressMonitor)

Saves the document to a memory buffer.

Note: - Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves the document to an OutputStream. Note: - Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves the document to an OutputStream.

Note: - Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves the document to a file. See save(String, SDFDoc.SaveMode, ProgressMonitor)

Saves the document to a file. If a full save is requested to the original path, the file is saved to a file system-determined temporary file, the old file is deleted, and the temporary file is renamed to path. A full save with remove unused or linearization option may re-arrange object in the cross reference table. Therefore all pointers and references to document objects and resources should be re acquired in order to continue document editing. In order to use incremental save the specified path must match original path and INCREMENTAL should be given.

Note: In a multi-threaded environment, the user is expected to acquire a write lock before attempting to save the document.

Note: - Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Note: - If the original pdf has a corrupt xref table (see HasRepairedXref or http://www.pdftron.com/kb_corrupt_xref), then it can not be saved using the INCREMENTAL mode.

Saves the document to a CustomFilter.

Note: Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves the document to an OutputStream. See save(OutputStream, SDFDoc.SaveMode, ProgressMonitor, int)

Saves the document incrementally to the same location as it was opened from.

Note: If the original pdf has a corrupt xref table (see HasRepairedXref or http://www.pdftron.com/kb_corrupt_xref), then this save can not be used.

Saves the document to a file. See save(Filter, SDFDoc.SaveMode)

Saves a custom signature Contents to a document which has been prepared to receive it. No changes should be made to document in meantime. The output goes into a Filter.

Note: This method ignores e_incremental flag. Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves a custom signature Contents to a document which has been prepared to receive it. No changes should be made to document in meantime. The output goes into a file at the provided path.

Saves only the incremental portion of the PDFDoc to path Works like saving using INCREMENTAL but only writes the portion that would have been appended to path.

Applies optimizations to improve viewing speed and saves the document to the specified file. The main optimizations used are linearization and embedding thumbnails for the first page and any complex pages.

Applies optimizations to improve viewing speed and saves the document to a memory buffer. The main optimizations used are linearization and embedding thumbnails for the first page and any other pages that are slow to render.

Set the Action that will be triggered when the document is opened.

Attaches a label to a page. This establishes the numbering scheme for that page and all following it, until another page label is encountered. This label allows PDF producers to define a page numbering system other than the default.

The function sets a new SecurityHandler as the current security handler.

Note: Setting a new security handler will not invalidate the access to the original file and will take effect during document Save().

Note: If the security handler is modified, document will perform a full save even if INCREMENTAL was given in Save() method.

Try locking the document, waiting no longer than specified number of milliseconds.

Tries to obtain a read lock the document for milliseconds duration, and returns true if the lock was successfully acquired

Try locking the document in non-blocking manner.

Try obtaining a read lock on the document in non-blocking manner.

Unlock the document.

Removes the read lock from the document.

Attempts to verify all signed cryptographic digital signatures in the document, ignoring unsigned signatures.