Class FormWidget

constructor

• new FormWidget(options?: Options): FormWidget

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns FormWidget

  Example

  const formWidget = await FormWidget.create();
  Copy

options

getAnnot

• getAnnot(): Promise<null | AnnotType>

  Gets the FRAnnot of the form widget.

  Returns Promise<null | AnnotType>

  • The FRAnnot of the form widget.

getFieldType

• getFieldType(): Promise<number>

  Gets the field type of the form widget.

  Returns Promise<number>

  • The field type of the form widget.

getFormControl

• getFormControl(): Promise<null | FormControlType>

  Gets the form control of the form widget.

  Returns Promise<null | FormControlType>

  • The form control of the form widget.

getFromInterForm

• getFromInterForm(
      doc: DocType,
      interForm: InterFormType,
      formControl: FormControlType,
  ): Promise<null | FormWidgetType>

  Gets the form widget from the inter form.

  Parameters

  • doc: DocType

    The document.
  • interForm: InterFormType

    The PDF inter form.
  • formControl: FormControlType

    The form control.

  Returns Promise<null | FormWidgetType>

  • The form widget.

resetAppearance

• resetAppearance(
      value: string,
      valueChanged: boolean,
      resetRV: boolean,
  ): Promise<void>

  Resets the appearance of the form widget and clears all cached appearances.

  Parameters

  • value: string

    The value to set.
  • valueChanged: boolean

    If the value changed.
  • resetRV: boolean

    If need to reset “RV” dictionary.

  Returns Promise<void>

Staticcreate

• create(options?: Options): Promise<FormWidgetType>

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns Promise<FormWidgetType>

  Create a FormWidget instance

  Example

  const formWidget = await FormWidget.create();
  Copy