PDFDoc Class

Creates a new empty PDF document.

Creates a new PDF document from an array of bytes.

Creates a new PDF document from the specified full path of the file.

Creates a new PDF document from an IStorageFile instance.

Creates a new PDF document from a buffer.

Creates a new PDF document from an IInputStream instance.

Creates a new PDF document from an IRandomAccessStream instance.

Creates a new PDF document from an existing IFilter instance.

Creates a new PDF document from an existing SDFDoc instance.

Creates a new PDF document from an IInputStream instance.

Creates a new PDF document from an IRandomAccessStream instance.

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 a signature handler to the signature manager.

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 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.

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.

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.

Creates an unsigned digital signature form field inside the document with an automatically-generated unique name.

Creates an unsigned digital signature form field inside the document.

Creates the indirect Array.

Creates the indirect bool.

Creates the indirect dict.

The following list of methods is used to create SDF/Cos indirect objects. Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects they can be shared).

Creates the indirect null.

Creates the indirect number.

Creates the indirect stream.

Creates the indirect stream.

Creates the indirect stream.

Creates the indirect stream.

Creates the indirect string.

Creates the indirect string.

Closes PDFDoc and release resources

Determines whether the specified Object is equal to the current Object.

Fdf extract.

Extract selected 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.

Field create.

Field create.

Field create.

Field create.

Flatten all annotations in the document.

Flatten all annotations in the document.

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

Gets the acro form.

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.

Gets the doc info.

field_name - a string representing the fully qualified name of the field (e.g. "employee.name.first").

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).

Gets the file name.

Serves as a hash function for a particular type.

Gets the OCG configuration.

Gets the oC gs.

Gets the page.

Gets the page count.

Gets the page iterator.

Gets the page iterator.

Gets the page label.

Gets the pages.

Gets the root.

Gets the SDFDoc.

Gets the security handler.

Gets the associated signature handler instance from the signature manager by looking it up with the provided id.

Gets the trailer.

Get the Action associated with the selected PDFDoc Trigger event

Gets the Type of the current instance.

Gets the view prefs.

Gets the structure tree.

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.

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.

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.

Inits the security handler.

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.

Inserts a range of pages from specified PDFDoc using PageSet

Checks if is encrypted.

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

Checks if is locked.

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

Checks if 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().

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.

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

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

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.

Page create.

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

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

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

Page remove.

Generates the appearance stream for annotations in the document using the default RefreshOptions. 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 specified 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 all changes incrementally to the document and writes them to the original source. Incremental saving is very fast, as it only appends data to the end of the file (and so is independent of the file size) This is suitable for quick save operations that you don't want to interrupt the user of the app.

Saves all changes incrementally document and writes them to the original source. Note that this might be slow, unless you are using the e_incremental flag only. Preferably shouldn't be used while the user is viewing the document. Saving with the e_incremental flag only will only append data, making the save fast no matter the original file size.

Saves all changes to the document and writes them to a file pointed by the given path.

Saves all changes to the document and writes them to an IRandomAccessStream instance without using the saved document as the new source. Note, this will assume that randomAccessStream is pointing to a different location that the PDFDoc currently is. If this is not the case, the behavior is undefined and may corrupt the underlying document.

Saves all changes to the document and writes them to an IOutputStream instance.

Saves all changes to the document and writes them to an IRandomAccessStream instance. Note, this save method will always create a copy of the document first, as it can no establish whether randomAccessStream is referring to the same location as the document, and so will make a copy for safety. If you know the location is different, then use SaveToNewLocationAsync.

Saves all changes to the document and writes them to file specified by the IStorageFile instance without using the saved document as the new source. Note, this will assume that randomAccessStream is pointing to a different location that the PDFDoc currently is. If this is not the case, the behavior is undefined and may corrupt the underlying document.

Saves all changes to the document and writes them to an IRandomAccessStream instance. Note, this save method will always create a copy of the document first, as it can no establish whether randomAccessStream is referring to the same location as the document, and so will make a copy for safety. If you know the location is different, then use SaveToNewLocationAsync.

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

Saves all changes to the document and writes them to an output IFilter sink without using the saved document as the new source.

Saves all changes to the document and writes them to a buffer.

Saves all changes to the document and writes them to an IRandomAccessStream instance. Note, this will assume that storageFile is pointing to a different location that the PDFDoc currently is. If this is not the case, the behavior is undefined and may corrupt the underlying document.

Saves all changes to the document and writes them to an IRandomAccessStream instance. Note, this will assume that randomAccessStream is pointing to a different location that the PDFDoc currently is. If this is not the case, the behavior is undefined and may corrupt the underlying document.

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.

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

Returns a string that represents the current object.

Try locking the document in non-blocking manner.

Removes the lock from the document.

Removes the read lock from the document.

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