ExportFormOptions Interface Reference

Export form options. More...

Public Attributes
Array< string >	fieldNames
	The names of the fields to export. More...
boolean	isExcludeFields
	Controls whether the fieldNames list is treated as an include or exclude filter. More...

Detailed Description

Export form options.

Since

11.0.0

See also

PDFForm.exportToFile

Member Data Documentation

fieldNames

Array<string> ExportFormOptions::fieldNames

The names of the fields to export.

Since

11.0.0

isExcludeFields

boolean ExportFormOptions::isExcludeFields

Controls whether the fieldNames list is treated as an include or exclude filter.

When true (default), the fieldNames list specifies fields to exclude from export. When false, the fieldNames list specifies the only fields that will be exported.

Example:

// Export only field1 and field2
const form = doc.getPDFForm();
await form.exportToFile(FileFormat.fdf, {
  fieldNames: ['field1', 'field2'], 
  isExcludeFields: false
});

// Export all fields except field1 and field2
await form.exportToFile(FileFormat.fdf, {
  fieldNames: ['field1', 'field2'],
  isExcludeFields: true  // default
});

Since

11.0.0