Class: RadioButtonFormField

PSPDFKit.FormFields.RadioButtonFormField

A group of radio buttons. Similar to PSPDFKit.FormFields.CheckBoxFormField, but there can only be one value set at the same time.

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

To retrieve a list of all form fields, use PSPDFKit.Instance#getFormFields.

Extends

Members




Members

annotationPdfObjectIds: Immutable.List.<string>

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

Type:
  • Immutable.List.<string>

defaultValue: string

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

Type:
  • string

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

noToggleToOff: boolean

If true, exactly one radio button must be selected at all times. Clicking the currently selected button has no effect. Otherwise, clicking the selected button deselects it, leaving no button selected.

Type:
  • boolean
Default Value:
  • false

options: Immutable.List.<PSPDFKit.FormOption>

A list of PSPDFKit.FormOptions. This is necessary to map the multiple radio button options to their values.

See PSPDFKit.FormOption for more information.

Type:

pdfObjectId: number

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

Type:
  • number

radiosInUnison: boolean

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unions: If one is checked, they are all checked (the same behavior as HTML radio buttons). Otherwise, only the checked radio button will be marked checked.

Type:
  • boolean
Default Value:
  • true

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

value: string

The selected form option value.

Type:
  • string