API Documentation for TextField

• API Documentation for TextField
  • NoPoDoFo TextField
  • Constructors
  • Properties
    • text
    • maxLen
    • multiLine
    • passwordField
    • fileField
    • spellCheckEnabled
    • scrollEnabled
    • combs
    • richText
  • Methods

NoPoDoFo TextField

A text field widget type Annotation. This field is responsible for handling user text input. This class is capable of handling a variety of text type inputs including: password fields, multiline text, and rich text. TextField is derived from the Field class. Please see the Appearance Stream Cookbook for examples of how to set the appearance stream for a text field.

class TextField extends Field {
  constructor(page: Page, fieldIndex: number)
  constructor(page: Page, annotation: Annotation, form: Form, opts?: Object)

  text: string
  maxLen: number
  multiLine: boolean
  passwordField: boolean
  fileField: boolean
  spellCheckEnabled: boolean
  scrollEnabled: boolean
  combs: boolean
  richText: boolean
}

Constructors

constructor(page: Page, fieldIndex: number)

Create a instance from an existing TextField

constructor(page: Page, annotation: Annotation, form: Form, opts?: Object)

Create a new instance of a TextField

Properties

text

Get and set the text value of the text field

maxLen

Define a maximum length limit for the text property

multiLine

Toggle multiline option

passwordField

Toggle password field text masking option

fileField

Toggle file field option. A file field describes the path to a file

spellCheckEnabled

Toggle spell checking of the text property

scrollEnabled

Enable scrolling for overflow text

combs

Toggle combs

richText

Toggle rich text

Methods