Class: TextFormField

PSPDFKit.FormFields.TextFormField

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

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>

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

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.

Type:
  • boolean
Default Value:
  • false

value: string

The current value of the form field.

Type:
  • string