Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextField

Hierarchy

Index

Methods

Methods

getAlignment

getBorderColor

  • getBorderColor(): Promise<number>

  • Get field's border color.

    see

    Field

    Returns Promise<number>

    • An integer indicated border color will be returned.

getBorderStyle

  • getBorderStyle(): Promise<string>

  • Get field's border style.

    see

    Field

    Returns Promise<string>

    • Border style, should be one of 'solid','dashed','inset','beveled','underline'. Nothing will be done with invalid string

getCharLimit

  • getCharLimit(): Promise<number>

  • Get Limits the number of characters.

    Returns Promise<number>

getControlsCount

  • getControlsCount(): Promise<number>

  • Get the count of field's controls.

    see

    Field

    Returns Promise<number>

    • Count of field's controls.

getDoNotScroll

  • getDoNotScroll(): Promise<boolean>

  • Returns Promise<boolean>

getDoNotSpellCheck

  • getDoNotSpellCheck(): Promise<boolean>

  • Returns Promise<boolean>

getFillColor

  • getFillColor(): Promise<number>

  • Get field's fill color.

    note

    Load all relative annotations before call this function, or wrong value will return.

    see

    [[setFilColor]]

    Returns Promise<number>

    • An integer indicated border color will be returned.

getFlags

  • Get field's flags. For more information.

    see

    FieldFlags

    Returns Promise<FieldFlags>

    • An integer indicated field's flags will be returned.

getMultiline

  • getMultiline(): Promise<boolean>

  • Returns Promise<boolean>

getName

  • getName(): Promise<string>

  • Get form field's name(aka title).

    Returns Promise<string>

    • Form field's name

getNumItems

  • getNumItems(): Promise<number>

getPasswordFlag

  • getPasswordFlag(): Promise<boolean>

  • Returns Promise<boolean>

getType

getValue

  • getValue(): Promise<string>

  • Get field value.

    Returns Promise<string>

    • Field's value

setAlignment

  • setAlignment(align: Alignment): Promise<void>

  • Controls how the text is laid out within the text field.

    see

    Alignment

    Parameters

    Returns Promise<void>

    void

setBorderColor

  • setBorderColor(color: number): Promise<undefined | boolean>

  • Set field's border color.

    see

    Field

    Parameters

    • color: number

    Returns Promise<undefined | boolean>

    void

setBorderStyle

  • Set field's border style(Not support signature field).

    see

    Field

    Parameters

    • style: FieldBorderStyle

      Border style, should be one of 'solid','dashed','inset','beveled'. Nothing will be done with invalid string

    Returns Promise<boolean>

setCharLimit

  • setCharLimit(maxLength: number): Promise<void>

  • Limits the number of characters that a user can type into a text field.

    Parameters

    • maxLength: number

    Returns Promise<void>

    void

setDoNotScroll

  • setDoNotScroll(isDoDotScroll: boolean): Promise<void>

  • Setting this property to true or false corresponds to checking or unchecking the Scroll Long Text field in the Options tab of the field.

    Parameters

    • isDoDotScroll: boolean

      If true, the text field does not scroll and the user, therefore, is limited by the rectangular region designed for the field.

    Returns Promise<void>

    unidefined

setDoNotSpellCheck

  • setDoNotSpellCheck(isDoNotSpellCheck: boolean): Promise<boolean>

  • Setting this property to true or false corresponds to unchecking or checking the Check Spelling attribute in the Options tab of the Field Properties dialog box.

    Parameters

    • isDoNotSpellCheck: boolean

      If true, spell checking is not performed on this editable text field.

    Returns Promise<boolean>

    unidefined

setFillColor

  • setFillColor(color: any): Promise<boolean>

  • Set field's fill color.

    Parameters

    • color: any

      An interge indecated fill color (alpha is not supported). Supported color format
      0 or ['T'] for transparent
      number, such as 0xff0000, 16711680
      PDF color array, such as ['RGB',1,1,1] which means white.
      HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'

    Returns Promise<boolean>

    boolean

setFlags

setMultiline

  • setMultiline(multiline: boolean): Promise<void>

  • Controls how text is wrapped within the field.

    Parameters

    • multiline: boolean

      If true, multiple lines are allowed and they wrap to field boundaries.

    Returns Promise<void>

    void

setPasswordFlag

  • setPasswordFlag(passwordFlag: boolean): Promise<void>

  • Specifies whether the field should display asterisks when data is entered in the field.

    Parameters

    • passwordFlag: boolean

      If true, data in the field is not saved when the document is saved to disk.

    Returns Promise<void>

    unidefined

setValue

  • setValue(value: string): Promise<void>

  • Set field's value.

    Parameters

    • value: string

      Field's value to be set.

    Returns Promise<void>

    void or the set value.