PDFSignature

pdf-lib › PDFSignature

Represents a signature field of a PDFForm.

PDFSignature fields are digital signatures. pdf-lib does not currently provide any specialized APIs for creating digital signatures or reading the contents of existing digital signatures.

Hierarchy

• PDFField

  ↳ PDFSignature

Index

Properties

• acroField
• doc
• ref

Methods

• disableExporting
• disableReadOnly
• disableRequired
• enableExporting
• enableReadOnly
• enableRequired
• getName
• isExported
• isReadOnly
• isRequired
• needsAppearancesUpdate
• of

Properties

acroField

• acroField: PDFAcroSignature

Overrides PDFField.acroField

Defined in api/form/PDFSignature.ts:34

The low-level PDFAcroSignature wrapped by this signature.

---

doc

• doc: PDFDocument

Inherited from PDFField.doc

Defined in api/form/PDFField.ts:92

The document to which this field belongs.

---

ref

• ref: PDFRef

Inherited from PDFField.ref

Defined in api/form/PDFField.ts:89

The unique reference assigned to this field within the document.

Methods

disableExporting

▸ disableExporting(): void

Inherited from PDFField.disableExporting

Defined in api/form/PDFField.ts:247

Indicate that this field's value should not be exported when the form is submitted in a PDF reader. For example:

const field = form.getField('some.field')
field.disableExporting()

Returns: void

---

disableReadOnly

▸ disableReadOnly(): void

Inherited from PDFField.disableReadOnly

Defined in api/form/PDFField.ts:170

Allow users to interact with this field and change its value in PDF readers via mouse and keyboard input. For example:

const field = form.getField('some.field')
field.disableReadOnly()

Returns: void

---

disableRequired

▸ disableRequired(): void

Inherited from PDFField.disableRequired

Defined in api/form/PDFField.ts:208

Do not require this field to have a value when the form is submitted. For example:

const field = form.getField('some.field')
field.disableRequired()

Returns: void

---

enableExporting

▸ enableExporting(): void

Inherited from PDFField.enableExporting

Defined in api/form/PDFField.ts:235

Indicate that this field's value should be exported when the form is submitted in a PDF reader. For example:

const field = form.getField('some.field')
field.enableExporting()

Returns: void

---

enableReadOnly

▸ enableReadOnly(): void

Inherited from PDFField.enableReadOnly

Defined in api/form/PDFField.ts:158

Prevent PDF readers from allowing users to interact with this field or change its value. The field will not respond to mouse or keyboard input. For example:

const field = form.getField('some.field')
field.enableReadOnly()

Useful for fields whose values are computed, imported from a database, or prefilled by software before being displayed to the user.

Returns: void

---

enableRequired

▸ enableRequired(): void

Inherited from PDFField.enableRequired

Defined in api/form/PDFField.ts:196

Require this field to have a value when the form is submitted. For example:

const field = form.getField('some.field')
field.enableRequired()

Returns: void

---

getName

▸ getName(): string

Inherited from PDFField.getName

Defined in api/form/PDFField.ts:128

Get the fully qualified name of this field. For example:

const fields = form.getFields()
fields.forEach(field => {
  const name = field.getName()
  console.log('Field name:', name)
})

Note that PDF fields are structured as a tree. Each field is the descendent of a series of ancestor nodes all the way up to the form node, which is always the root of the tree. Each node in the tree (except for the form node) has a partial name. Partial names can be composed of any unicode characters except a period (.). The fully qualified name of a field is composed of the partial names of all its ancestors joined with periods. This means that splitting the fully qualified name on periods and taking the last element of the resulting array will give you the partial name of a specific field.

Returns: string

The fully qualified name of this field.

---

isExported

▸ isExported(): boolean

Inherited from PDFField.isExported

Defined in api/form/PDFField.ts:223

Returns true if this field's value should be exported when the form is submitted. See PDFField.enableExporting and PDFField.disableExporting. For example:

const field = form.getField('some.field')
if (field.isExported()) console.log('Exporting is enabled')

Returns: boolean

Whether or not this field's value should be exported.

---

isReadOnly

▸ isReadOnly(): boolean

Inherited from PDFField.isReadOnly

Defined in api/form/PDFField.ts:143

Returns true if this field is read only. This means that PDF readers will not allow users to interact with the field or change its value. See PDFField.enableReadOnly and PDFField.disableReadOnly. For example:

const field = form.getField('some.field')
if (field.isReadOnly()) console.log('Read only is enabled')

Returns: boolean

Whether or not this is a read only field.

---

isRequired

▸ isRequired(): boolean

Inherited from PDFField.isRequired

Defined in api/form/PDFField.ts:184

Returns true if this field must have a value when the form is submitted. See PDFField.enableRequired and PDFField.disableRequired. For example:

const field = form.getField('some.field')
if (field.isRequired()) console.log('Field is required')

Returns: boolean

Whether or not this field is required.

---

needsAppearancesUpdate

▸ needsAppearancesUpdate(): boolean

Overrides void

Defined in api/form/PDFSignature.ts:50

Returns: boolean

---

Static of

▸ of(acroSignature: PDFAcroSignature, ref: PDFRef, doc: PDFDocument): PDFSignature‹›

Defined in api/form/PDFSignature.ts:27

NOTE: You probably don't want to call this method directly. Instead, consider using the PDFForm.getSignature method, which will create an instance of PDFSignature for you.

Create an instance of PDFSignature from an existing acroSignature and ref

Parameters:

Name	Type	Description
acroSignature	PDFAcroSignature	The underlying PDFAcroSignature for this signature.
ref	PDFRef	The unique reference for this signature.
doc	PDFDocument	The document to which this signature will belong.

Returns: PDFSignature‹›