PdfFormFieldExportSettings

6 Feb 20262 minutes to read

Represents form fields export settings.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Sets the form field data export settings with output data format.
let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
// Set the data format defined in form field export settings.
settings.dataFormat = DataFormat.json;
// Export form field to JSON format
let json: Uint8Array = document.exportFormData(settings);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

Get asPerSpecification boolean

Gets the boolean value indicating whether the data in a form field can be exported based on a certain specification.

Set asPerSpecification void

Sets the boolean value indicating whether the data in a form field can be exported based on a certain specification.

Parameter	Type	Description
value	boolean	The boolean value.

Get dataFormat DataFormat

Gets the data format defined in form field export settings.

Set dataFormat void

Sets the data format defined in form field export settings.

Parameter	Type	Description
format	DataFormat	Specifies the data format.

Get exportName string

Gets the export name defined in form field export settings.

Set exportName void

Sets the export name defined in form field export settings.

Parameter	Type	Description
name	string	Specifies the export name of the form.