Property form of getActions.
Child fields: fields here hold widgets directly with no child fields, so always an empty array.
Default value (/DV): readable and writable (a text string) for text fields and combo boxes / lists; for check boxes / radios /DV is a name, which the Worker does not write, and reads as an empty string. On assignment written to each widget, then updateAnnotation commits.
Default value (/DV): readable and writable (a text string) for text fields and combo boxes / lists; for check boxes / radios /DV is a name, which the Worker does not write, and reads as an empty string. On assignment written to each widget, then updateAnnotation commits.
Export value: the first widget's export value for buttons, otherwise the field value.
Field flags: those of the first widget (or those given at creation without widgets); on assignment each widget gets a copy, then updateAnnotation commits.
Field flags: those of the first widget (or those given at creation without widgets); on assignment each widget gets a copy, then updateAnnotation commits.
Font of the field: taken from the first widget (the engine reads and writes /DA on widgets); an empty font without widgets.
Some widget has uncommitted changes.
Options of combo boxes / lists; always null for other types. On assignment written to each widget, then updateAnnotation commits.
Text shown for the option.
Export value of the option.
Options of combo boxes / lists; always null for other types. On assignment written to each widget, then updateAnnotation commits.
OptionaldisplayValue?: stringText shown for the option; defaults to value.
Export value of the option.
Text alignment: that of the first widget.
Tooltip (/TU); on assignment written to each widget, then updateAnnotation commits.
Tooltip (/TU); on assignment written to each widget, then updateAnnotation commits.
Property form of getValue / setValue; on assignment a failed commit (such as in read-only mode) only logs a warning; use setValue / commit to await the result.
Property form of getValue / setValue; on assignment a failed commit (such as in read-only mode) only logs a warning; use setValue / commit to await the result.
The second argument is the type, or the options { type, value, flags }.
Fully qualified name of the field.
Optionaloptions: The field type, or the type, initial value and flags.
Optionalflags?: WidgetFlagsInitial field flags.
Optionaltype?: FieldType | undefinedField type; 'Tx' by default.
Optionalvalue?: FieldValue | undefinedInitial value.
Same as setValue (commit may also run validation actions, but there are no scripts here, so it just sets the value); widget is only a hint, the value belongs to the whole field.
Optional_widget: WidgetAnnotationActions of the field: those on the first widget (button click actions and so on).
Gets the field type.
'Tx', 'Btn', 'Ch' or 'Sig'.
The user this field belongs to (exported and imported with the XFDF field definition, not written to the PDF).
Hides all widgets of the field.
Fields here hold widgets directly with no child fields.
Redraws each widget (the appearance is regenerated by the engine after every write).
Sets several properties at once: value (set directly), defaultValue, tooltipName, flags, options; missing ones are ignored.
OptionaldefaultValue?: string | numberNew default value.
Optionalflags?: WidgetFlagsNew field flags.
Optionaloptions?: { displayValue?: string; value: string }[] | nullNew options of combo boxes and lists.
OptionaltooltipName?: stringNew tooltip (alternate name).
Optionalvalue?: FieldValueNew value.
Sets the user this field belongs to (exported and imported with the XFDF field definition, not written to the PDF).
The user name.
Buttons: widgets whose export value equals the value are checked, the rest unchecked; true checks the first widget (check box), false / null unchecks all. Rejects in read-only mode without changing any widget.
const { annotationManager } = instance.Core;
const fieldManager = annotationManager.getFieldManager();
await fieldManager.getField('name').setValue('Jane Doe'); // text field
await fieldManager.getField('agree').setValue(true); // check box
await fieldManager.getField('country').setValue('France'); // combo box
Shows all widgets of the field.
ReadonlyinitialField flags given when creating the field; widgets created with this field carry them.
ReadonlyinitialInitial value and flags given when creating the field (options): widgets created with this field carry them.
Fully qualified name of the field.
ReadonlytypeField type: 'Tx' (text), 'Btn' (button, check box, radio), 'Ch' (choice) or 'Sig' (signature).
ReadonlywidgetsWidgets (form field annotations) of this field.
A form field: the set of widgets that share a name and a value.