PDFFileElement: formData property

Value

An object whose keys are annotation IDs (such as "12R") and whose values are objects with a value property, as PDF.js stores them. Setting it applies the values to every page.

When PDFium holds the form (js in the file's -), the keys are field names, and the object has the fields that were changed. Setting it takes field names too, with a { value } object or the value itself: a string for a text field, an array of options for a list, true, false or an export value for a check box, and the export value of a radio button.

To read or write form data as a file, use XFDF; to save the filled PDF, use PDFFileElement.save().

Examples

Reading the filled values

const file = document.querySelector("pdf-file");
for (const [id, { value }] of Object.entries(file.formData)) console.log(id, value);

Specifications

Not part of any specification. <pdf-file> and <pdf-page> are autonomous custom elements defined by WebPDF.pro. It implements:

Browser compatibility

See also

• PDFPageAnnoLayer.sync()
• PDFFileElement.XFDF
• Forms and XFDF