Class: FormFieldValue

PSPDFKit.FormFieldValue

Record representing a form field value.

To retrieve a list of all form field values, use PSPDFKit.Instance#getFormFieldValues.

Please see our forms guide article to learn more about forms and for examples on how to set form field values.

Constructor

new PSPDFKit.FormFieldValue()

Type representing a single form field value.

Example

Setting a form field value.

const formFieldValue = new PSPDFKit.FormFieldValue({
  name: 'Form field name',
  value: 'Form field value'
});
instance.update(formFieldValue);

Extends

  • Immutable.Record

Members



Members

name: string

Unique name of the form field (often referred to as fully qualified name). This name is used to link form field value to a PSPDFKit.FormFields.FormField.

Type:
  • string

(nullable) optionIndexes: PSPDFKit.Immutable.List.<number>

Radio buttons and checkboxes can have multiple widgets with the same form value associated, but can be selected independently. optionIndexes contains the value indexes that should be actually set.

If set, the value field doesn't get used, and the widget found at the corresponding indexes in the form field's annotationIds property are checked.

If set on fields other than radio buttons or checkboxes, setting the form value will fail.

Type:

value: string

The value of the form field.

Type:
  • string

See also