Class: TextFormField

PSPDFKit.FormFields.TextFormField

A text input element, that can either span a single or multiple lines.

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

Extends

Members



Members

(nullable) additionalActions: PSPDFKit.FormFieldAdditionalActions

Optional actions to execute when an event is triggered.

Type:
Default Value:
  • null

annotationIds: Immutable.List.<string>

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

Type:
  • Immutable.List.<string>

(readonly) canSetGroup: boolean

This property defines whether the user has permission to edit the group of this form field. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

comb: boolean

If true, every character will have an input element on their own which is evenly distributed inside the bounding box of the widget annotation. When this is set, the form field must have a maxLength.

Type:
  • boolean
Default Value:
  • false

defaultValue: string

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

Type:
  • string

doNotScroll: boolean

If true, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation’s rectangle. Once the field is full, no further text is accepted.

Type:
  • boolean
Default Value:
  • false

doNotSpellCheck: boolean

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

Type:
  • boolean
Default Value:
  • false

group: string

This property is used to define the permission scope for this form-field, it's corresponding widget-annotations and form field values. If you change the group of a form field, the corresponding widget annotations and form field values will inherit it.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • string

id: string

A unique identifier to describe the form field record. When a form field is created in the UI, the viewer has to generate a unique ID.

When changes are saved to the underlying form field provider, we call PSPDFKit.Instance#ensureFormFieldSaved to make sure the form field has been persisted from the provider.

Type:
  • string

(readonly) isDeletable: boolean

This property defines whether this form field can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

(readonly) isEditable: boolean

This property defines whether this form-field can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

(readonly) isFillable: boolean

This property defines whether this form-field can be filled or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

label: string

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

Type:
  • string

(nullable) maxLength: number

The maximum length of the field’s text, in characters. If none is set, the size is not limited.

Type:
  • number
Default Value:
  • null

multiLine: boolean

If true, the field can contain multiple lines of text. Otherwise, the field’s text is restricted to a single line.

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

password: boolean

If true, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.

This is currently only support for single line text inputs.

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.

PSPDFKit.FormFields.TextFormField, PSPDFKit.FormFields.ComboBoxFormField and PSPDFKit.FormFields.ListBoxFormField with this flag set will be rendered with the PSPDFKit-Annotation-Widget-Required public CSS class and the HTML required attribute set.

Type:
  • boolean
Default Value:
  • false

(readonly) value: string

The current value of the form field. In order to modify it, instance.setFormFieldValues() should be used.

Type:
  • string