PDFTron WebViewer

Class: PDFDoc

Core.PDFNet. PDFDoc

new PDFDoc()

PDFDoc is a high-level class describing a single PDF (Portable Document Format) document. Most applications using PDFNet will use this class to open existing PDF documents, or to create new PDF documents from scratch. The class offers a number of entry points into the document. For example, - To access pages use pdfdoc.getPageIterator() or pdfdoc.getPage(page_num). - To access form fields use pdfdoc.getFieldIterator(), pdfdoc.getFieldIterator(name) or pdfdoc.getField(name). - To access document's meta-data use pdfdoc.getDocInfo(). - To access the outline tree use pdfdoc.getFirstBookmark(). - To access low-level Document Catalog use pdfdoc.getRoot(). ... The class also offers utility methods to slit and merge PDF pages, to create new pages, to flatten forms, to change security settings, etc.

Extends

Classes

DiffOptions
MergeXFDFOptions
RefreshOptions
TextDiffOptions
ViewerOptimizedOptions

Members

<static> EventType

Type:
  • number
Properties:
Name Type Description
e_action_trigger_doc_will_close number
e_action_trigger_doc_will_save number
e_action_trigger_doc_did_save number
e_action_trigger_doc_will_print number
e_action_trigger_doc_did_print number

<static> ExtractFlag

Type:
  • number
Properties:
Name Type Description
e_forms_only number
e_annots_only number
e_both number

<static> InsertFlag

Type:
  • number
Properties:
Name Type Description
e_none number
e_insert_bookmark number

<static> SignaturesVerificationStatus

Type:
  • number
Properties:
Name Type Description
e_unsigned number
e_failure number
e_untrusted number
e_unsupported number
e_verified number

Methods

<static> create()

Default constructor. Creates an empty new document.
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDoc"
Type
Promise.<Core.PDFNet.PDFDoc>

<static> createDiffOptions()

Method to create a DiffOptions object
Returns:
A promise that resolves to a PDFNet.PDFDoc.DiffOptions.
Type
Promise.<Core.PDFNet.PDFDoc.DiffOptions>

<static> createFromBuffer(buf)

Open a SDF/Cos document from a memory buffer. Note: the document should be fully loaded in the memory buffer. Note: the buffer ownership is not transfered to the document so the user should clean-up any allocated memory if necessary.
Parameters:
Name Type Description
buf ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray a memory buffer containing the serialized document
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDoc"
Type
Promise.<Core.PDFNet.PDFDoc>

<static> createFromFilter(stream)

Open an existing PDF document
Parameters:
Name Type Description
stream Core.PDFNet.Filter input stream containing a serialized document. The input stream may be a random-access file, memory buffer, slow HTTP connection etc. 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 MappedFile 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. Note: PDFDoc takes the ownership of the stream.
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDoc"
Type
Promise.<Core.PDFNet.PDFDoc>

<static> createFromLayoutEls(buf)

Parameters:
Name Type Description
buf ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDoc"
Type
Promise.<Core.PDFNet.PDFDoc>

<static> createFromURL(url [, options])

Open a PDF document from a url. This function will fully download the file as a memory buffer and create a PDFDoc object.
Parameters:
Name Type Argument Description
url string The url from which to download the file
options object <optional>
 Additional options
Properties
Name Type Description
withCredentials boolean Whether to set the withCredentials property on the XMLHttpRequest
customHeaders object An object containing custom HTTP headers to be used when downloading the document
Returns:
A promise that resolves to an object of type: "PDFDoc".
Type
Promise.<Core.PDFNet.PDFDoc>

<static> createMergeXFDFOptions()

Method to create a MergeXFDFOptions object
Returns:
A promise that resolves to a PDFNet.PDFDoc.MergeXFDFOptions.
Type
Promise.<Core.PDFNet.PDFDoc.MergeXFDFOptions>

<static> createRefreshOptions()

Method to create a RefreshOptions object
Returns:
A promise that resolves to a PDFNet.PDFDoc.RefreshOptions.
Type
Promise.<Core.PDFNet.PDFDoc.RefreshOptions>

<static> createTextDiffOptions()

Method to create a TextDiffOptions object
Returns:
A promise that resolves to a PDFNet.PDFDoc.TextDiffOptions.
Type
Promise.<Core.PDFNet.PDFDoc.TextDiffOptions>

<static> createViewerOptimizedOptions()

Method to create a ViewerOptimizedOptions object
Returns:
A promise that resolves to a PDFNet.PDFDoc.ViewerOptimizedOptions.
Type
Promise.<Core.PDFNet.PDFDoc.ViewerOptimizedOptions>

<static> highlightTextDiff(doc1, doc2 [, options])

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.
Parameters:
Name Type Argument Description
doc1 Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc is the before document, the basis of the comparison
doc2 Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc is the after document, to which the basis is compared
options Core.PDFNet.PDFDoc.TextDiffOptions <optional>
 processing options (optional)
Returns:
A promise that resolves to the total number of differences found Note: This function is beta and is subject to change
Type
Promise.<number>

addFileAttachment(file_key, embedded_file)

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.
Parameters:
Name Type Description
file_key string A key/name under which the attachment will be stored.
embedded_file Core.PDFNet.FileSpec Embedded file stream Note: Another way to associate a file attachment with the document is using SDF::NameTree: 
  SDF::NameTree names = SDF::NameTree::Create(doc, "EmbeddedFiles");
  names.Put(file_key, file_keysz, embedded_file.GetSDFObj());
Returns:
Type
Promise.<void>

addHighlights(hilite)

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.
Parameters:
Name Type Description
hilite string a string representing the filename for the highlight file or or a data buffer containing XML data.
Returns:
Type
Promise.<void>

addRootBookmark(root_bookmark)

Adds/links the specified Bookmark to the root level of document's outline tree.
Parameters:
Name Type Description
root_bookmark Core.PDFNet.Bookmark Bookmark to Add/link Note: parameter 'root_bookmark' must not be linked (must not be belong) to a bookmark tree.
Returns:
Type
Promise.<void>

addSignatureHandler(signature_handler)

Adds a signature handler to the signature manager.
Parameters:
Name Type Description
signature_handler Core.PDFNet.SignatureHandler The signature handler instance to add to the signature manager.
Returns:
A promise that resolves to a unique ID representing the SignatureHandler within the SignatureManager.
Type
Promise.<number>

addStdSignatureHandlerFromBuffer(pkcs12_buffer, pkcs12_pass)

Parameters:
Name Type Description
pkcs12_buffer ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray
pkcs12_pass string
Returns:
A promise that resolves to an object of type: "number"
Type
Promise.<number>

addStdSignatureHandlerFromURL(pkcs12_file, pkcs12_pass)

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.
Parameters:
Name Type Description
pkcs12_file string The private key certificate store to use.
pkcs12_pass string The passphrase for the provided private key.
Returns:
A promise that resolves to a unique ID representing the SignatureHandler within the SignatureManager.
Type
Promise.<number>

appendTextDiffDoc(doc1, doc2 [, options])

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.
Parameters:
Name Type Argument Description
doc1 Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc is the before document, the basis of the comparison (read-only)
doc2 Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc is the after document, to which the basis is compared (read-only)
options Core.PDFNet.PDFDoc.TextDiffOptions <optional>
 processing options (optional)
Returns:
A promise that resolves to the total number of differences found Note: This function is beta and is subject to change
Type
Promise.<number>

appendTextDiffPage(page1, page2)

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.
Parameters:
Name Type Description
page1 Core.PDFNet.Page is the before page, the basis of the comparison (read-only)
page2 Core.PDFNet.Page is the after page, to which the basis is compared (read-only)
Returns:
A promise that resolves to the total number of differences found Note: This function is beta and is subject to change
Type
Promise.<number>

appendVisualDiff(p1, p2 [, opts])

Add a page representing the difference between two pdf pages to this document.
Parameters:
Name Type Argument Description
p1 Core.PDFNet.Page one of the two pages for comparing
p2 Core.PDFNet.Page the other page for comparing
opts Core.PDFNet.PDFDoc.DiffOptions <optional>
 options for comparison results. This parameter is supposed to be an object, which can be generated by 'PDFNet.createDiffOptions()'. If this parameter is omitted or set to null, default settings will be used.
Returns:
Type
Promise.<void>

convertToXodStream( [options])

Generate a stream that incrementally converts the pdf to XOD format.
Parameters:
Name Type Argument Description
options Core.PDFNet.Obj | Core.PDFNet.Convert.XODOutputOptions <optional>
 the conversion options
See:
  • XODOutputOptions
  • ToPdf()
Returns:
A filter from which the file can be read incrementally.
Type
Promise.<Core.PDFNet.Filter>

createDigitalSignatureField( [in_sig_field_name])

Creates an unsigned digital signature form field inside the document.
Parameters:
Name Type Argument Description
in_sig_field_name string <optional>
 The fully-qualified name to give the digital signature field. If one is not provided, a unique name is created automatically.
Returns:
A promise that resolves to a DigitalSignatureField object representing the created digital signature field.
Type
Promise.<Core.PDFNet.DigitalSignatureField>

createIndirectArray()

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).
Returns:
A promise that resolves to returns a new indirect array object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectBool(value)

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).
Parameters:
Name Type Description
value boolean the value with which to create the boolean object.
Returns:
A promise that resolves to returns a new indirect boolean object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectDict()

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).
Returns:
A promise that resolves to returns a new indirect dict object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectName(name)

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).
Parameters:
Name Type Description
name string
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<Core.PDFNet.Obj>

createIndirectNull()

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).
Returns:
A promise that resolves to returns a new indirect null object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectNumber(value)

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).
Parameters:
Name Type Description
value number the value with which to create the number object.
Returns:
A promise that resolves to returns a new indirect number object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectStream(data, filter_chain)

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).
Parameters:
Name Type Description
data ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray a buffer from which to create the stream object.
filter_chain Core.PDFNet.Filter filter object with which to create the stream object. Defaults to Filters::Filter(0,false)
Returns:
A promise that resolves to returns a new indirect stream object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectStreamFromFilter(data [, filter_chain])

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).
Parameters:
Name Type Argument Description
data Core.PDFNet.FilterReader reference to a FilterReader object with which to create the stream object.
filter_chain Core.PDFNet.Filter <optional>
 filter object with which to create the stream object. Defaults to Filters::Filter(0,false)
Returns:
A promise that resolves to returns a new indirect stream object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectString(value, buf_size)

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).
Parameters:
Name Type Description
value number Unsigned char pointer with which to create the string object.
buf_size number length of string.
Returns:
A promise that resolves to returns a new indirect string object.
Type
Promise.<Core.PDFNet.Obj>

createIndirectStringFromUString(str)

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).
Parameters:
Name Type Description
str string reference to string with which to create the string object.
Returns:
A promise that resolves to returns a new indirect string object.
Type
Promise.<Core.PDFNet.Obj>

createShallowCopy()

Copy Constructor
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDoc"
Type
Promise.<Core.PDFNet.PDFDoc>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

fdfExtract( [flag])

Extract form data and/or annotations to FDF
Parameters:
Name Type Argument Description
flag number <optional>
 
PDFNet.PDFDoc.ExtractFlag = {
	e_forms_only : 0
	e_annots_only : 1
	e_both : 2
}
specifies extract options
Returns:
A promise that resolves to a pointer to the newly created FDF file with an interactive data.
Type
Promise.<Core.PDFNet.FDFDoc>

fdfExtractPageSet(pages_to_extract [, flag])

Extract form data and/or annotations to FDF
Parameters:
Name Type Argument Description
pages_to_extract Core.PDFNet.PageSet The set of pages for which to extract interactive data.
flag number <optional>
 
PDFNet.PDFDoc.ExtractFlag = {
	e_forms_only : 0
	e_annots_only : 1
	e_both : 2
}
specifies extract options
Returns:
A promise that resolves to a pointer to the newly created FDF file with an interactive data.
Type
Promise.<Core.PDFNet.FDFDoc>

fdfMerge(fdf_doc)

Import form data from FDF file to PDF interactive form.
Parameters:
Name Type Description
fdf_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc a reference to the FDF file
Returns:
Type
Promise.<void>

fdfUpdate(fdf_doc)

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.
Parameters:
Name Type Description
fdf_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc a pointer to the FDF file
Returns:
Type
Promise.<void>

fieldCreate(field_name, type [, field_value] [, def_field_value])

Create a new interactive form Field.
Parameters:
Name Type Argument Description
field_name string a string representing the fully qualified name of the field (e.g. "employee.name.first"). field_name must be either a unique name or equal to an existing terminal field name.
type number 
PDFNet.Field.Type = {
	e_button : 0
	e_check : 1
	e_radio : 2
	e_text : 3
	e_choice : 4
	e_signature : 5
	e_null : 6
}
field type (e.g. Field::e_text, Field::e_button, etc.)
field_value Core.PDFNet.Obj <optional>
def_field_value Core.PDFNet.Obj <optional>
Returns:
A promise that resolves to the new form Field.
Type
Promise.<Core.PDFNet.Field>

fieldCreateFromStrings(field_name, type, field_value [, def_field_value])

Create a new interactive form Field.
Parameters:
Name Type Argument Description
field_name string a string representing the fully qualified name of the field (e.g. "employee.name.first"). field_name must be either a unique name or equal to an existing terminal field name.
type number 
PDFNet.Field.Type = {
	e_button : 0
	e_check : 1
	e_radio : 2
	e_text : 3
	e_choice : 4
	e_signature : 5
	e_null : 6
}
field type (e.g. Field::e_text, Field::e_button, etc.)
field_value string
def_field_value string <optional>
Returns:
A promise that resolves to the new form Field.
Type
Promise.<Core.PDFNet.Field>

flattenAnnotations( [forms_only])

Flatten all annotations in the document.
Parameters:
Name Type Argument Description
forms_only boolean <optional>
 if false flatten all annotations, otherwise flatten only form fields.
Returns:
Type
Promise.<void>

generateThumbnails(size)

Generates thumbnail images for all the pages in this PDF document.
Parameters:
Name Type Description
size number The maximum dimension (width or height) that thumbnails will have.
Returns:
Type
Promise.<void>

getAcroForm()

Returns:
A promise that resolves to the AcroForm dictionary located in "/Root" or NULL if dictionary is not present.
Type
Promise.<Core.PDFNet.Obj>

getDigitalSignatureFieldIteratorBegin()

Retrieves an iterator that iterates over digital signature fields.
Returns:
A promise that resolves to an iterator that iterates over digital signature fields.
Type
Promise.<Core.PDFNet.Iterator.<Core.PDFNet.DigitalSignatureField>>

getDigitalSignaturePermissions()

Retrieves the most restrictive document permissions locking level from all of the signed digital signatures in the document.
Returns:
A promise that resolves to an enumerated value representing the most restrictive document permission level found in the document.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.DigitalSignatureField.DocumentPermissions = {
	e_no_changes_allowed : 1
	e_formfilling_signing_allowed : 2
	e_annotating_formfilling_signing_allowed : 3
	e_unrestricted : 4
}
</pre>

getDocInfo()

Returns:
A promise that resolves to the class representing document information metadata. (i.e. entries in the document information dictionary).
Type
Promise.<Core.PDFNet.PDFDocInfo>

getDownloadedByteCount()

Returns the number of bytes that have been downloaded, when `HasDownloader()` is True.
Returns:
A promise that resolves to the number bytes downloaded.
Type
Promise.<number>

getField(field_name)

Parameters:
Name Type Description
field_name string a string representing the fully qualified name of the field (e.g. "employee.name.first").
Returns:
A promise that resolves to a FieldIterator referring to an interactive Field or to invalid field if the field name was not found. If a given field name was not found itr.HasNext() will return false. For example: 
FieldIterator itr = pdfdoc.GetFieldIterator("name");
if (itr.HasNext()) {
  Console.WriteLine("Field name: {0}", itr.Current().GetName());
}
else { ...field was not found... }
Type
Promise.<Core.PDFNet.Field>

getFieldIterator(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).
Parameters:
Name Type Description
field_name string String representing the name of the field to get.
Returns:
A promise that resolves to an iterator to the Field in the document. For a sample, please refer to 'InteractiveForms' sample project.
Type
Promise.<Core.PDFNet.Iterator.<Core.PDFNet.Field>>

getFieldIteratorBegin()

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).
Returns:
A promise that resolves to an iterator to the first Field in the document. 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.
Type
Promise.<Core.PDFNet.Iterator.<Core.PDFNet.Field>>

getFirstBookmark()

Returns:
A promise that resolves to the first Bookmark from the document's outline tree. If the Bookmark tree is empty the underlying SDF/Cos Object is null and returned Bookmark is not valid (i.e. Bookmark::IsValid() returns false).
Type
Promise.<Core.PDFNet.Bookmark>

getGeometryCollectionForPage(page_num)

Parameters:
Name Type Description
page_num number
Returns:
A promise that resolves to an object of type: "PDFNet.GeometryCollection"
Type
Promise.<Core.PDFNet.GeometryCollection>

getOCGConfig()

Returns:
A promise that resolves to the default optional-content configuration for the document from the OCProperties D entry.
Type
Promise.<Core.PDFNet.OCGConfig>

getOCGs()

Returns:
A promise that resolves to the Obj array that contains optional-content groups (OCGs) for the document, or NULL if the document does not contain any OCGs. The order of the groups is not guaranteed to be the creation order, and is not the same as the display order.
Type
Promise.<Core.PDFNet.Obj>

getOpenAction()

Returns:
A promise that resolves to action that is triggered when the document is opened. The returned action can be either a destination or some other kind of Action (see Section 8.5, 'Actions' in PDF Reference Manual). Note: if the document does not nave associated action the returned Action will be null (i.e. Action.IsValid() returns false)
Type
Promise.<Core.PDFNet.Action>

getPage(page_number)

Parameters:
Name Type Description
page_number number the page number in document's page sequence. Page numbers in document's page sequence are indexed from 1.
Returns:
A promise that resolves to a Page corresponding to a given page number, or null (invalid page) if the document does not contain the given page number. For example: 
 
  Page page = pdfdoc.GetPage(page_num);
  if (page == null) return; //  Page not found
Type
Promise.<Core.PDFNet.Page>

getPageCount()

Returns:
A promise that resolves to the number of pages in the document.
Type
Promise.<number>

getPageIterator( [page_number])

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.
Parameters:
Name Type Argument Description
page_number number <optional>
 page to set the iterator on. 1 corresponds to the first page.
Returns:
A promise that resolves to an iterator to the first page in the document.
Type
Promise.<Core.PDFNet.Iterator.<Core.PDFNet.Page>>

getPageLabel(page_num)

Parameters:
Name Type Description
page_num number The page number. Because PDFNet indexes pages starting from 1, page_num must be larger than 0.
Returns:
A promise that resolves to the PageLabel that is in effect for the given page. If there is no label object in effect, this method returns an invalid page label object.
Type
Promise.<Core.PDFNet.PageLabel>

getPages()

Returns:
A promise that resolves to A dictionary representing the root of the low level page-tree
Type
Promise.<Core.PDFNet.Obj>

getRoot()

Returns:
A promise that resolves to A dictionary representing the Cos root of the document (/Root entry within the trailer dictionary)
Type
Promise.<Core.PDFNet.Obj>

getSDFDoc()

Returns:
A promise that resolves to document's SDF/Cos document
Type
Promise.<Core.PDFNet.SDFDoc>

getSecurityHandler()

Returns:
A promise that resolves to currently selected SecurityHandler. 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 e_incremental was given as a flag in Save() method.
Type
Promise.<Core.PDFNet.SecurityHandler>

getSignatureHandler(signature_handler_id)

Gets the associated signature handler instance from the signature manager by looking it up with the handler name.
Parameters:
Name Type Description
signature_handler_id number The unique id of the signature handler to get.
Returns:
A promise that resolves to the signature handler instance if found, otherwise NULL.
Type
Promise.<Core.PDFNet.SignatureHandler>

getStructTree()

Returns:
A promise that resolves to the document's logical structure tree root.
Type
Promise.<Core.PDFNet.STree>

getTotalRemoteByteCount()

Returns the document's total size in bytes, when `HasDownloader()` is True.
Returns:
A promise that resolves to the total number of bytes in the remote document.
Type
Promise.<number>

getTrailer()

Returns:
A promise that resolves to A dictionary representing the Cos root of the document (document's trailer)
Type
Promise.<Core.PDFNet.Obj>

getTriggerAction(trigger)

Get the Action associated with the selected Doc Trigger event.
Parameters:
Name Type Description
trigger number 
PDFNet.PDFDoc.EventType = {
	e_action_trigger_doc_will_close : 17
	e_action_trigger_doc_will_save : 18
	e_action_trigger_doc_did_save : 19
	e_action_trigger_doc_will_print : 20
	e_action_trigger_doc_did_print : 21
}
the type of trigger event to get
Returns:
A promise that resolves to the Action Obj if present, otherwise NULL
Type
Promise.<Core.PDFNet.Obj>

getUndoManager()

Returns:
A promise that resolves to the UndoManager object (one-to-one mapped to document)
Type
Promise.<Core.PDFNet.UndoManager>

getViewPrefs()

Returns:
A promise that resolves to viewer preferences for this 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.
Type
Promise.<Core.PDFNet.PDFDocViewPrefs>

hasOC()

Returns:
A promise that resolves to true if the optional content (OC) feature is associated with the document. The document is considered to have optional content if there is an OCProperties dictionary in the document's catalog, and that dictionary has one or more entries in the OCGs array.
Type
Promise.<boolean>

hasRepairedXRef()

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.
Returns:
A promise that resolves to true if document was found to be corrupted, and was repaired, during opening and has not been saved since. Note: If this function returns true, it is not possible to incrementally save the document (see http://www.pdftron.com/kb_corrupt_xref)
Type
Promise.<boolean>

hasSignatures()

Indicates whether this documents contains any digital signatures.
Returns:
A promise that resolves to true if a digital signature is found in this PDFDoc.
Type
Promise.<boolean>

importPages(page_arr [, import_bookmarks])

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.
Parameters:
Name Type Argument Description
page_arr Array.<Core.PDFNet.Page> A list of pages to import. All pages should belong to the same source document.
import_bookmarks boolean <optional>
 An optional flag specifying whether any bookmark items pointing to pages in the import list should be merged with the target (i.e. this) document.
Returns:
A promise that resolves to a list of imported pages. Note that imported pages are not placed in the document page sequence. This can be done using methods such as PageInsert(), PagePushBack(), etc.
Type
Promise.<Array.<Core.PDFNet.Page>>

initSecurityHandler()

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.
Returns:
A promise that resolves to true if the SecurityHandler was successfully initialized (this may include authentication data collection, verification etc.), false otherwise.
Type
Promise.<boolean>

initStdSecurityHandler(password)

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.
Parameters:
Name Type Description
password string Specifies the password used to open the document without any user feedback.
Returns:
A promise that resolves to true if the given password successfully unlocked the document, false otherwise.
Type
Promise.<boolean>

initStdSecurityHandlerBuffer(password_buf)

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.
Parameters:
Name Type Description
password_buf ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray Specifies the password used to open the document without any user feedback. If you would like to dynamically obtain the password, you need to derive a custom class from StdSecurityHandler() and use InitSecurityHandler() without any parameters. See EncTest sample for example code.
Returns:
A promise that resolves to true if the given password successfully unlocked the document, false otherwise.
Type
Promise.<boolean>

initStdSecurityHandlerUString(password)

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.
Parameters:
Name Type Description
password string Specifies the password used to open the document without any user feedback. If you would like to dynamically obtain the password, you need to derive a custom class from StdSecurityHandler() and use InitSecurityHandler() without any parameters. See EncTest sample for example code.
Returns:
A promise that resolves to true if the given password successfully unlocked the document, false otherwise.
Type
Promise.<boolean>

insertPages(insert_before_page_number, src_doc, start_page, end_page, flag)

Inserts a range of pages from specified PDFDoc
Parameters:
Name Type Description
insert_before_page_number number the destination of the insertion. If less than or equal to 1, the pages are added to the beginning of the document. If larger than the number of pages in the destination document, the pages are appended to the document.
src_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc source PDFDoc to insert from
start_page number start of the page number to insert
end_page number end of the page number to insert
flag number 
PDFNet.PDFDoc.InsertFlag = {
	e_none : 0
	e_insert_bookmark : 1
}
specifies insert options
Returns:
Type
Promise.<void>

insertPageSet(insert_before_page_number, src_doc, source_page_set, flag)

Inserts a range of pages from specified PDFDoc using PageSet
Parameters:
Name Type Description
insert_before_page_number number the destination of the insertion. If less than or equal to 1, the pages are added to the beginning of the document. If larger than the number of pages in the destination document, the pages are appended to the document.
src_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc source PDFDoc to insert from
source_page_set Core.PDFNet.PageSet a collection of the page number to insert
flag number 
PDFNet.PDFDoc.InsertFlag = {
	e_none : 0
	e_insert_bookmark : 1
}
specifies insert options
Returns:
Type
Promise.<void>

isEncrypted()

Returns:
A promise that resolves to true if the document is/was originally encrypted false otherwise.
Type
Promise.<boolean>

isLinearized()

Call this function to determine whether the document is represented in linearized (fast web view) format.
Returns:
A promise that resolves to true if document is stored in fast web view format, false otherwise. 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 'Doc.SaveOptions.e_linearized' flag in the Save method.
Type
Promise.<boolean>

isModified()

Call this function to determine whether the document has been modified since it was last saved.
Returns:
A promise that resolves to true if document was modified, false otherwise
Type
Promise.<boolean>

isTagged()

Returns:
A promise that resolves to true if this document is marked as Tagged PDF, false otherwise.
Type
Promise.<boolean>

isXFA()

Returns:
A promise that resolves to an object of type: "boolean"
Type
Promise.<boolean>

jsContextInitialize()

Returns:
Type
Promise.<void>

lock()

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().
Returns:
Type
Promise.<void>

lockRead()

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.
Returns:
Type
Promise.<void>

mergeXFDF(stream [, options])

Parameters:
Name Type Argument Description
stream Core.PDFNet.Filter
options Core.PDFNet.PDFDoc.MergeXFDFOptions <optional>
Returns:
Type
Promise.<void>

mergeXFDFString(xfdf [, options])

Parameters:
Name Type Argument Description
xfdf string
options Core.PDFNet.PDFDoc.MergeXFDFOptions <optional>
Returns:
Type
Promise.<void>

movePages(move_before_page_number, src_doc, start_page, end_page, flag)

Moves a range of pages from specified PDFDoc. Pages are deleted from source document after move.
Parameters:
Name Type Description
move_before_page_number number the destination of the move. If less than or equal to 1, the pages are moved to the beginning of the document. If larger than the number of pages in the destination document, the pages are moved to the end of the document.
src_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc source PDFDoc to move from
start_page number start of the page number to move
end_page number end of the page number to move
flag number 
PDFNet.PDFDoc.InsertFlag = {
	e_none : 0
	e_insert_bookmark : 1
}
specifies insert options Note: MovePages function does not save src_doc. It merely delete pages in memeory. For permanent changes, PDFDoc::Save should be used to save src_doc after function exists.
Returns:
Type
Promise.<void>

movePageSet(move_before_page_number, src_doc, source_page_set, flag)

Moves a range of pages from specified PDFDoc. Pages are deleted from source document after move.
Parameters:
Name Type Description
move_before_page_number number the destination of the move. If less than or equal to 1, the pages are moved to the beginning of the document. If larger than the number of pages in the destination document, the pages are moved to the end of the document.
src_doc Core.PDFNet.PDFDoc | Core.PDFNet.SDFDoc | Core.PDFNet.FDFDoc source PDFDoc to move from
source_page_set Core.PDFNet.PageSet a collection of the page number to move
flag number 
PDFNet.PDFDoc.InsertFlag = {
	e_none : 0
	e_insert_bookmark : 1
}
specifies insert options Note: MovePages function does not save src_doc. It merely delete pages in memeory. For permanent changes, PDFDoc::Save should be used to save src_doc after function exists.
Returns:
Type
Promise.<void>

pageCreate( [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.
Parameters:
Name Type Argument Description
media_box Core.PDFNet.Rect <optional>
 A rectangle, expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed. A user space units is 1/72 of an inch. If media_box is not specified the default dimensions of the page are 8.5 x 11 inches (or 8.5*72, 11*72 units).

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)
Returns:
A promise that resolves to a new, empty page. Note: the new page still does not belong to document page sequence and should be subsequently placed at a specific location within the sequence.
Type
Promise.<Core.PDFNet.Page>

pageInsert(where, page)

Insert/Import a single page at a specific location in the page sequence.
Parameters:
Name Type Description
where Core.PDFNet.Iterator.<Core.PDFNet.Page> The location in the page sequence indicating where to insert the page. The page is inserted before the specified location.
page Core.PDFNet.Page A page to insert. Note: Invalidates all PageIterators pointing to the document.
Returns:
Type
Promise.<void>

pagePushBack(page)

Adds a page to the end of a document's page sequence.
Parameters:
Name Type Description
page Core.PDFNet.Page a page to append to the document Note: Invalidates all PageIterators pointing to the document.
Returns:
Type
Promise.<void>

pagePushFront(page)

Adds a page to the beginning of a document's page sequence.
Parameters:
Name Type Description
page Core.PDFNet.Page a page to prepend to the document Invalidates all PageIterators pointing to the document.
Returns:
Type
Promise.<void>

pageRemove(page_itr)

Parameters:
Name Type Description
page_itr Core.PDFNet.Iterator.<Core.PDFNet.Page> the PageIterator to the page that should be removed A PageIterator for the given page can be obtained using PDFDoc::GetPageIterator(page_num) or using direct iteration through document's page sequence.
Returns:
Type
Promise.<void>

refreshAnnotAppearances( [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.
Parameters:
Name Type Argument Description
options Core.PDFNet.PDFDoc.RefreshOptions <optional>
 Options that can be used to adjust this generation process.
Returns:
Type
Promise.<void>

refreshFieldAppearances()

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.
Returns:
Type
Promise.<void>

removePageLabel(page_num)

removes the page label that is attached to the specified page, effectively merging the specified range with the previous page label sequence.
Parameters:
Name Type Description
page_num number The page from which the page label is removed. Because PDFNet indexes pages starting from 1, page_num must be larger than 0.
Returns:
Type
Promise.<void>

removeSecurity()

This function removes document security.
Returns:
Type
Promise.<void>

removeSignatureHandler(signature_handler_id)

Removes a signature handler from the signature manager.
Parameters:
Name Type Description
signature_handler_id number The unique id of the signature handler to remove.
Returns:
Type
Promise.<void>

requirePage(page_number)

WebViewer only - Ensures that a particular page of the pdf document is finished loading before reading or writing from it. Recommended to be called before runGeneratorWithCleanup/WithoutCleanup is called. If the page(s) to be edited cannot be known until during the execution of the PDFNetJS script, all operations will need to be unlocked with PDFNet.finishOperation() and [PDFDoc].unlock() before [PDFDoc].requirePage() can be called, and relocked again with PDFNet.beginOperation() and [PDFDoc].lock() 
doc.unlock();
yield PDFNet.finishOperation();
yield doc.requirePage(pageCounter);
yield PDFNet.beginOperation();
doc.lock();
Parameters:
Name Type Description
page_number number The page to ensure completion of.
Returns:
Type
Promise.<void>

saveCustomSignatureBuffer(in_signature, in_field)

Saves a custom signature Contents to a document which has been prepared to receive it. No changes should be made to document in meantime.
Parameters:
Name Type Description
in_signature ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray The signature Contents to write
in_field Core.PDFNet.DigitalSignatureField The signature field to which to write
Returns:
A promise that resolves to an object of type: "Uint8Array"
Type
Promise.<Uint8Array>

saveCustomSignatureStream(in_signature, in_field)

Saves a custom signature Contents to a document which has been prepared to receive it. No changes should be made to document in meantime.
Parameters:
Name Type Description
in_signature ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray The signature Contents to write
in_field Core.PDFNet.DigitalSignatureField The signature field to which to write
Returns:
A promise that resolves to an object of type: "PDFNet.Filter"
Type
Promise.<Core.PDFNet.Filter>

saveMemoryBuffer(flags)

Saves the document to a memory buffer.
Parameters:
Name Type Description
flags number A bit field composed of an OR of SDFDoc::SaveOptions values. Note that this method ignores e_incremental flag.
Returns:
A promise that resolves to a Uint8Array containing file data. Note: Save will modify the PDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.
Type
Promise.<Uint8Array>

saveStream(stream, flags)

Saves the document to a stream.
Parameters:
Name Type Description
stream Core.PDFNet.Filter The output stream where to write data.
flags number A bit field composed of an OR of the SDFDoc::SaveOptions values. 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), then it can not be saved using the e_incremental flag.
Returns:
Type
Promise.<void>

saveViewerOptimizedBuffer(opts)

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.
Parameters:
Name Type Description
opts Core.PDFNet.Obj | Core.PDFNet.PDFDoc.ViewerOptimizedOptions The optimization options
Returns:
A promise that resolves to an object of type: "Uint8Array"
Type
Promise.<Uint8Array>

setOpenAction(action)

Sets the Action that will be triggered when the document is opened.
Parameters:
Name Type Description
action Core.PDFNet.Action A new Action that will be triggered when the document is opened. An example of such action is a GoTo Action that takes the user to a given location in the document.
Returns:
Type
Promise.<void>

setPageLabel(page_num, label)

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.
Parameters:
Name Type Description
page_num number The number of the page to label. If page_num is less than 1 or greater than the number of pages in the document, the method does nothing.
label Core.PDFNet.PageLabel
Returns:
Type
Promise.<void>

setSecurityHandler(handler)

The function sets a new SecurityHandler as the current security handler.
Parameters:
Name Type Description
handler Core.PDFNet.SecurityHandler new SecurityHandler 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 e_incremental was given as a flag in Save() method.
Returns:
Type
Promise.<void>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void

timedLock(milliseconds)

Try locking the document, waiting no longer than specified number of milliseconds.
Parameters:
Name Type Description
milliseconds number max number of milliseconds to wait for the document to lock
Returns:
A promise that resolves to true if the document is locked for multi-threaded access, false otherwise.
Type
Promise.<boolean>

timedLockRead(milliseconds)

Tries to obtain a read lock the document for duration, and returns true if the lock was successfully acquired
Parameters:
Name Type Description
milliseconds number duration to obtain a read lock for.
Returns:
A promise that resolves to true if the document is locked for multi-threaded access, false otherwise.
Type
Promise.<boolean>

tryLock()

Try locking the document.
Returns:
A promise that resolves to true if the document is locked for multi-threaded access, false otherwise.
Type
Promise.<boolean>

tryLockRead()

Tries to obtain a read lock the document and returns true if the lock was successfully acquired
Returns:
A promise that resolves to true if the document is locked for multi-threaded access, false otherwise.
Type
Promise.<boolean>

unlock()

Removes the lock from the document.
Returns:
Type
Promise.<void>

unlockRead()

Removes the read lock from the document.
Returns:
Type
Promise.<void>

verifySignedDigitalSignatures(opts)

Attempts to verify all signed cryptographic digital signatures in the document, ignoring unsigned signatures.
Parameters:
Name Type Description
opts Core.PDFNet.VerificationOptions
Returns:
A promise that resolves to an enumeration value representing the state of the document's signatures
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.PDFDoc.SignaturesVerificationStatus = {
	e_unsigned : 0
	e_failure : 1
	e_untrusted : 2
	e_unsupported : 3
	e_verified : 4
}
</pre>