Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckBoxField

Hierarchy

Index

Accessors

Methods

Accessors

isBoxChecked

  • get isBoxChecked(): Promise<boolean>

  • Checks or unchecks the specified checkbox.

    Returns Promise<boolean>

Methods

checkThisBox

  • checkThisBox(bchecked: boolean): Promise<void>

  • Checks or unchecks the specified checkbox.

    Parameters

    • bchecked: boolean

      {boolean}

    Returns Promise<void>

    void

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

getCheckBoxStyle

getControlsCount

  • getControlsCount(): Promise<number>

  • Get the count of field's controls.

    see

    Field

    Returns Promise<number>

    • Count of field's controls.

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.

getName

  • getName(): Promise<string>

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

    Returns Promise<string>

    • Form field's name

getNumItems

  • getNumItems(): Promise<number>

getType

getValue

  • getValue(): Promise<string>

  • Get field value.

    Returns Promise<string>

    • Field's value

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>

setCheckBoxStyle

  • Set the glyph style of a check box or radio button.
    The glyph style is the graphic used to indicate that the item has been selected.

    see

    CheckBoxStyle

    Parameters

    Returns Promise<boolean>

    boolean

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

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.