Class: ComboBoxFormField

PSPDFKit.FormFields.ComboBoxFormField

A combo box is a drop down box with the option to add custom entries (see PSPDFKit.FormFields.ComboBoxFormField#edit).

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>

doNotSpellCheck: boolean

If true, text entered in the field is not spell-checked.

Type:
  • boolean
Default Value:
  • false

edit: boolean

If true, the combo box includes an editable text box as well as a drop-down list. Otherwise, it includes only a drop-down list.

Type:
  • boolean
Default Value:
  • false

label: string

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

Type:
  • string

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

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