Class FormControl

constructor

• new FormControl(options?: Options): FormControl

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

  Parameters

  • Optionaloptions: Options

  Returns FormControl

  Example

  const FormControl = await FormControl.create();
  Copy

options

getBackgroundColor

• getBackgroundColor(): Promise<number[]>

  Gets the border color of the form control.

  Returns Promise<number[]>

  • The background color of the form control

getBorderColor

• getBorderColor(): Promise<number[]>

  Gets the border color of the form control.

  Returns Promise<number[]>

  • The border color of the form control

getDict

• getDict(): Promise<null | PDFDictionaryType>

  Gets the dictionary of the form control.

  Returns Promise<null | PDFDictionaryType>

  • The dictionary of the form control

getField

• getField(): Promise<null | FormFieldType>

  Gets the field of the form control.

  Returns Promise<null | FormFieldType>

  • The field of the form control

getInterForm

• getInterForm(): Promise<null | InterFormType>

  Gets the form widget from the inter form.

  Returns Promise<null | InterFormType>

  • The interactive form it belongs to

getRect

• getRect(): Promise<Rect>

  Gets the rectangle of the form control.

  Returns Promise<Rect>

  • The rectangle of the form control

getRotation

• getRotation(): Promise<number>

  Gets the rotation of the form control.

  Returns Promise<number>

  • The rotation of the form control

getType

• getType(): Promise<FPD_FormFieldType>

  Gets the field type of the form control.

  Returns Promise<FPD_FormFieldType>

  • The field type of the form control.

isChecked

• isChecked(): Promise<boolean>

  Gets the value of the form control.

  Returns Promise<boolean>

  • Whether the form control is checked

isDefaultChecked

• isDefaultChecked(): Promise<boolean>

  Gets the default checked state of the form control.

  Returns Promise<boolean>

  • Whether the form control is default checked

setBackgroundColor

• setBackgroundColor(color: { color: number[] }): Promise<void>

  Sets the border color of the form control.

  Parameters

  • color: { color: number[] }

    The background color to set.

  Returns Promise<void>

setBorderColor

• setBorderColor(color: { color: number[] }): Promise<void>

  Sets the border color of the form control.

  Parameters

  • color: { color: number[] }

    The color to set.

  Returns Promise<void>

setRotation

• setRotation(deg: number): Promise<void>

  Sets the rotation of the form control.

  Parameters

  • deg: number

    The degree to set.

  Returns Promise<void>

Staticcreate

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

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

  Parameters

  • Optionaloptions: Options

  Returns Promise<FormControlType>

  Create a FormControl instance

  Example

  const formControl = await FormControl.create();
  Copy