PTPDFDoc

Default constructor. Creates an empty new document.

Undocumented

Undocumented

Undocumented

Undocumented

Close PDFDoc

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.

@exception An exception is thrown if the matching handler for document’s security was not found in the global SecurityManager. In this case, you need to register additional custom security handlers with the global SecurityManager (using SecurityManagerSingleton).

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.

@exception An exception is thrown if the document’s security Filter is not ‘Standard’. In this case, you need to register additional custom security handlers with the global SecurityManager (SecurityManagerSingleton).

@remark Deprecated. Use versions that accepts UString or buffer instead.

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.

@exception An exception is thrown if the document’s security Filter is not ‘Standard’. In this case, you need to register additional custom security handlers with the global SecurityManager (SecurityManagerSingleton).

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

This function removes document security.

Indicates whether this documents contains any digital signatures.

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.

Removes a signature handler from the signature manager.

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

Creates an unsigned digital signature form field inside the document.

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.

PDFDocViewPrefs is a high-level utility class that can be used to control the way the document is to be presented on the screen or in print.

Get the Action associated with the selected Doc Trigger event.

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

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.

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

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 ‘Doc.SaveOptions.e_linearized’ flag in the Save method.

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

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

@exception if ‘HasDownloader()` returns False, calling this method will result in an exception.

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

@exception if ‘HasDownloader()` returns False, calling this method will result in an exception.

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 e_incremental flag bit should be set.

@exception - if the file can’t be opened for saving or if there is a problem during Save an Exception object will be thrown.

Saves the document to a stream.

@exception - if there is a problem during Save an Exception object will be thrown.

Undocumented

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

@exception - if there is a problem during Save an Exception object will be thrown.

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

@exception - if there is a problem during Save an Exception object will be thrown.

Use the Next() method on the returned iterator to traverse all pages in the document. For example:

   PageIterator itr = pdfdoc.GetPageIterator();
   while (itr.HasNext()) { //  Read every page
      Page page = itr.Current();
      // ...
      itr.Next()
   }

For full sample code, please take a look at ElementReader, PDFPageTest and PDFDraw sample projects.

For example:

   Page page = pdfdoc.GetPage(page_num);
   if (page == null) return; //  Page not found

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

Inserts a range of pages from specified PDFDoc

Inserts a range of pages from specified PDFDoc using PageSet

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.

Adds a page to the beginning of a document’s page sequence.

Adds a page to the end of a document’s page sequence.

The function imports a list of pages to this document. 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.

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.

The following is a listing of some standard U.S. page sizes:

• Letter = Rect(0, 0, 612, 792)
• Legal = Rect(0, 0, 612, 1008)
• Ledger = Rect(0, 0, 1224, 792)
• Tabloid = Rect(0, 0, 792, 1224)
• Executive = Rect(0, 0, 522, 756)

The following is a listing of ISO standard page sizes:

• 4A0 = Rect(0, 0, 4768, 6741)
• 2A0 = Rect(0, 0, 3370, 4768)
• A0 = Rect(0, 0, 2384, 3370)
• A1 = Rect(0, 0, 1684, 2384)
• A2 = Rect(0, 0, 1191, 1684)
• A3 = Rect(0, 0, 842, 1191)
• A4 = Rect(0, 0, 595, 842)
• A5 = Rect(0, 0, 420, 595)
• A6 = Rect(0, 0, 298, 420)
• A7 = Rect(0, 0, 210, 298)
• A8 = Rect(0, 0, 147, 210)
• A9 = Rect(0, 0, 105, 147)
• A10 = Rect(0, 0, 74, 105)
• B0 = Rect(0, 0, 2835, 4008)
• B1 = Rect(0, 0, 2004, 2835)
• B2 = Rect(0, 0, 1417, 2004)
• B3 = Rect(0, 0, 1001, 1417)
• B4 = Rect(0, 0, 709, 1001)
• B5 = Rect(0, 0, 499, 709)
• B6 = Rect(0, 0, 354, 499)
• B7 = Rect(0, 0, 249, 354)
• B8 = Rect(0, 0, 176, 249)
• B9 = Rect(0, 0, 125, 176)
• B10 = Rect(0, 0, 88, 125)
• C0 = Rect(0, 0, 2599, 3677)
• C1 = Rect(0, 0, 1837, 2599)
• C2 = Rect(0, 0, 1298, 1837)
• C3 = Rect(0, 0, 918, 1298)
• C4 = Rect(0, 0, 649, 918)
• C5 = Rect(0, 0, 459, 649)
• C6 = Rect(0, 0, 323, 459)
• C7 = Rect(0, 0, 230, 323)
• C8 = Rect(0, 0, 162, 230)
• C9 = Rect(0, 0, 113, 162)
• C10 = Rect(0, 0, 79, 113)

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

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

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

The list of all Fields present in the document can be traversed as follows:

 FieldIterator itr = pdfdoc.GetFieldIterator();
 for(; itr.HasNext(); itr.Next()) {
   Field field = itr.Current();
   Console.WriteLine("Field name: {0}", field.GetName());
  }

For a sample, please refer to ‘InteractiveForms’ sample project.

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

For a sample, please refer to ‘InteractiveForms’ sample project.

 FieldIterator itr = pdfdoc.GetFieldIterator("name");
 if (itr.HasNext()) {
   Console.WriteLine("Field name: {0}", itr.Current().GetName());
 }
 else { ...field was not found... }

Create a new interactive form Field.

@exception if ‘field_name’ is equal to an existing non-terminal field name an exception is thrown.

Create a new interactive form Field.

@exception if ‘field_name’ is equal to an existing non-terminal field name an exception is thrown.

Undocumented

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.

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.

Flatten all annotations in the document.

Extract form data and/or annotations to FDF

Extract form data and/or annotations to FDF

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

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

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.

SDF::NameTree names = SDF::NameTree::Create(doc, "EmbeddedFiles");
names.Put(file_key, file_keysz, embedded_file.GetSDFObj());

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.

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

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.

@exception An exception will be thrown if the XML file is malformed or os out of sync with the document.

This method creates an SDF/Cos indirect name object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect array object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect boolean object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect dict object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect null object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect number object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect string object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

This method creates an SDF/Cos indirect stream object

Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects can be shared).

Locks the document to prevent competing threads from accessing 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().

Removes the lock from the document.

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

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.

Removes the read lock from the document.

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

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

Generates a PDF diff of the given pages by overlaying and blending them on top of each other.

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.

@exception if the file can’t be opened for saving or if there is a problem during Save an Exception object will be thrown.

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

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.

Undocumented

Undocumented

Synchronously acquires a read lock for this PTPDFDoc instance and executes the given block on the current queue.

Synchronously acquires a write lock for this PTPDFDoc instance and executes the given block.

Simultaneous write access to a PTPDFDoc instance is not allowed. A write lock cannot be acquired if the thread already holds a read lock. Attempting to do so is an error.

Synchronously acquires a read lock for this PTPDFDoc instance and executes the given block on the current queue.

Any NSException thrown while locking or unlocking the document, or executing the block, is converted into an NSError object and returned in the error parameter.

Synchronously acquires a write lock for this PTPDFDoc instance and executes the given block.

Simultaneous write access to a PTPDFDoc instance is not allowed. A write lock cannot be acquired if the thread already holds a read lock. Attempting to do so is an error.

Any NSException thrown while locking or unlocking the document, or executing the block, is converted into an NSError object and returned in the error parameter.

Enumerates through the pages in this document and calls the provided block for each page.

Enumerates through the pages in this document between the start and end page numbers and calls the provided block for each page.

Generates a new unique ID for the given annotation.