Document

Document

This class provides information about the document level properties of the specified PDF file, such as tags, fonts, PDF Version etc.

Methods

isXFA() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is based on the XFA (Extensible Forms Architecture) format.

Returns:

True if the specified PDF file is based on the XFA format. False otherwise

Type
boolean

isAcroform() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file contains any form fields.

Returns:

True if the specified PDF file contains any form fields. False otherwise.

Type
boolean

fileSize() → {string}

Description:
  • Returns the size of the specified PDF file.

Returns:

The size of the specified PDF file.

Type
string

containsEmbeddedFiles() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file contains any embedded files.

Returns:

True if the specified PDF file contains any embedded files. False otherwise.

Type
boolean

incrementalSaveCount() → {number}

Description:
  • Returns the count of the number of times the specified PDF file is edited and saved.

Returns:

The count of the number of times the specified PDF file is edited and saved.

Type
number

isCertified() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file has been digitally signed with a certifying signature.

Returns:

True if the specified PDF file has been digitally signed with a certifying signature. False otherwise.

Type
boolean

isSigned() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is digitally signed.

Returns:

True if the specified PDF file is digitally signed. False otherwise.

Type
boolean

isEncrypted() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is encrypted.

Returns:

True if the specified PDF file is encrypted. False otherwise.

Type
boolean

isLinearized() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is linearized.

Returns:

True if the specified PDF file is linearized. False otherwise.

Type
boolean

isPortfolio() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is a portfolio PDF.

Returns:

True if the specified PDF file is a portfolio PDF. False otherwise.

Type
boolean

isTagged() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is tagged.

Returns:

True if the specified PDF file is tagged. False otherwise.

Type
boolean

isFullyTaggedPDF() → {boolean}

Description:
  • Returns a boolean specifying whether the specified PDF file is a Fully Tagged PDF.

Returns:

True if the specified PDF file is a Fully Tagged PDF. False otherwise.

Type
boolean

pageCount() → {number}

Description:
  • Returns a number specifying the number of pages in the specified PDF file.

Returns:

The number of pages in the specified PDF file.

Type
number

pdfVersion() → {string}

Description:
  • Returns a string specifying the version of the specified PDF file - e.g. "1.7", "2.0" etc.

Returns:

The version of the specified PDF file.

Type
string

pdfAComplianceLevel() → {string}

Description:
  • Returns a string specifying the PDF/A compliance level for the specified PDF file - e.g "PDF/A-4" etc.

Returns:

The PDF/A compliance level for the specified PDF file.

Type
string

pdfEComplianceLevel() → {string}

Description:
  • Returns a string specifying the PDF/E compliance level for the specified PDF file - e.g. "PDF/E-1" etc.

Returns:

The PDF/E compliance level for the specified PDF file.

Type
string

pdfUAComplianceLevel() → {string}

Description:
  • Returns a string specifying the PDF/UA compliance level for the specified PDF file - e.g. "PDF/UA-1" etc.

Returns:

The PDF/UA compliance level for the specified PDF file.

Type
string

pdfVTComplianceLevel() → {string}

Description:
  • Returns a string specifying the PDF/VT compliance level for the specified PDF file - e.g. "PDF/VT-3" etc.

Returns:

The PDF/VT compliance level for the specified PDF file.

Type
string

pdfXComplianceLevel() → {string}

Description:
  • Returns a string specifying the PDF/X compliance level for the specified PDF file - e.g. "PDF/X-4" etc.

Returns:

The PDF/X compliance level for the specified PDF file.

Type
string

fonts() → {Array.<Font>}

Description:
  • Returns an array of Font instances present in the specified PDF file.

Returns:

An array of Font instances.

Type
Array.<Font>

infoDict() → {InfoDict}

Description:
  • Returns an InfoDict instance that specifies information related to the specified PDF file such as creation date, author etc.

Returns:

An InfoDict instance.

Type
InfoDict

xmpMetadata() → {string}

Description:
  • Returns a string specifying the full metadata of the specified PDF file as provided by the author and producer of the document.

Returns:

The full metadata of the specified PDF file as provided by the author and producer of the document.

Type
string