Class: ChoiceFormField

PSPDFKit.FormFields.ChoiceFormField

Base form field type for all form fields that allow multiple choices:

Form fields classes instances cannot be modified with PSPDFKit for Web.

Extends

Members




Members

annotationPdfObjectIds: Immutable.List.<string>

Holds an immutable list of PSPDFKit.Annotations.WidgetAnnotation#ids.

Type:
  • Immutable.List.<string>

commitOnChange: boolean

If true, the new value is committed as soon as a selection is made, without requiring the user to exit the field. Otherwise, the new value is not committed until the user exits the field.

Type:
  • boolean
Default Value:
  • false

defaultValues: Immutable.List.<string>

Similar to the value property. The default values are only used when a form needs to be reset.

Type:
  • Immutable.List.<string>

label: string

Used to identify the form field in the UI or for accessibility.

Type:
  • string

multiSelect: boolean

If true, more than one of the field’s option items may be selected simultaneously. Otherwise, no more than one item at a time may be selected.

Type:
  • boolean
Default Value:
  • false

name: string

Unique name of the form field (often referred to as fully qualified name). This name is used to link PSPDFKit.Annotations.WidgetAnnotation and is also used as an identifier for form field values.

Type:
  • string

noExport: boolean

Form fields with the noExport flag won't appear in the serialized payload of a form submission.

Type:
  • boolean
Default Value:
  • false

options: Immutable.List.<PSPDFKit.FormOption>

A list of PSPDFKit.FormOptions. This is necessary for multiple check boxes in a group.

See PSPDFKit.FormOption for more information.

Type:

pdfObjectId: number

The object ID of the form field object in the PDF.

Type:
  • number

readOnly: boolean

Read only form fields can not be filled out (similar to disabled HTML input elements).

Type:
  • boolean
Default Value:
  • false

required: boolean

Required form fields must be filled out in order to submit the form.

Type:
  • boolean
Default Value:
  • false

values: Immutable.List.<string>

An immutable list of all selected form option values. If no options are defined, a checked check box will have values: List(["Yes"]);.

If the list is empty, no check box is checked.

Type:
  • Immutable.List.<string>