API Documentation for Form

• API Documentation for Form
  • NoPoDoFo Form
  • Constructors
  • Properties
    • needAppearances
    • dictionary
    • DA
    • DR
    • CO
    • SigFlags
  • Methods

NoPoDoFo Form

A Form or AcroForm is a Dictionary containing all the Annotation for the Document. NoPoDoFo supports creating, modifying, and filling interactive forms (AcroForm). To access a documents acroform use the Document.form accessor. You can use the acroform's dictionary to access the fields array, but the preferred way is through the page. All annotations are indexed and easily available via getField, getFields, getAnnotation and getAnnotations.
Please see the spec section 12.7 for more information

class Form {
  needAppearances: boolean
  readonly dictionary: Dictionary
  DA?: string
  DR?: Dictionary
  CO?: Dictionary
  SigFlags?: NPDFSigFlags
}

Constructors

Properties

needAppearances

Enable or disable the use of the default appearance stream. An acroforms default appearance stream is 12pt black arial. You can override the defaults on the annotation directly.

dictionary

Get the underlying Dictionary

DA

Get or set the default appearance value. The DA value is used for formatting the text annotation values. Note the AP key if present will take precedence over the DA value.

DR

The DR value is the resource Dictionary for the form, this dictionary contains the default resources used by the form Field Annotations.

CO

The CO Dictionary contains additional Actions defined by Annotations. An action can be a calculation or re-calculation of a Fields value or a Javascript script to execute when the annotations action is triggered.

SigFlags

Get or set SigFlags flags as one of NPDFSigFlags.

Methods