Class FormField

constructor

• new FormField(options?: Options): FormField

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

  Parameters

  • Optionaloptions: Options

  Returns FormField

  Example

  const formField = await FormField.create();
  Copy

options

checkControl

• checkControl(
      controlIndex: number,
      checked: boolean,
      notify: boolean,
  ): Promise<boolean>

  Checks the state of a control in the form field.

  Parameters

  • controlIndex: number

    The index of the control to check.
  • checked: boolean

    Whether the control should be checked or not.
  • notify: boolean

    Whether to notify changes.

  Returns Promise<boolean>

  • Returns true if the control state was successfully checked, otherwise false.

getAlternateName

• getAlternateName(): Promise<string>

  get alternate name

  Returns Promise<string>

  • Returns the alternate name of the form field

getControlByIndex

• getControlByIndex(index: number): Promise<null | FormControlType>

  get control by index

  Parameters

  • index: number

    The index of the control to retrieve

  Returns Promise<null | FormControlType>

  • Returns the form control object at the specified index

getControlsCount

• getControlsCount(): Promise<number>

  get controls count

  Returns Promise<number>

  • Returns the count of controls

getFieldDict

• getFieldDict(): Promise<null | PDFDictionaryType>

  get field dictionary

  Returns Promise<null | PDFDictionaryType>

  • Returns the field dictionary object

getFieldFlags

• getFieldFlags(): Promise<number>

  get field flags

  Returns Promise<number>

  • Returns the field flags as a number

getFieldType

• getFieldType(): Promise<number>

  get field type

  Returns Promise<number>

  • Returns the field type as a number

getFullName

• getFullName(): Promise<string>

  get full name

  Returns Promise<string>

  • Returns the full name of the form field

getInterForm

• getInterForm(): Promise<null | InterFormType>

  get InterForm

  Returns Promise<null | InterFormType>

  • Returns the InterForm object

getOptionsCount

• getOptionsCount(): Promise<number>

  Gets the count of options in the form field.

  Returns Promise<number>

  • Returns the count of options in the form field.

insertOption

• insertOption(optLabel: string, index: number, notify: boolean): Promise<number>

  Inserts an option into the form field at a specified index.

  Parameters

  • optLabel: string

    The label of the option to insert.
  • index: number

    The index at which to insert the option.
  • notify: boolean

    Whether to notify changes.

  Returns Promise<number>

  • Returns the index of the inserted option.

setAlternateName

• setAlternateName(name: string): Promise<void>

  set alternate name

  Parameters

  • name: string

    The alternate name to set for the form field

  Returns Promise<void>

  • No return value

setFieldFlags

• setFieldFlags(flags: number): Promise<void>

  set field flags

  Parameters

  • flags: number

    The flags to set for the form field

  Returns Promise<void>

  • No return value

setOptionValue

• setOptionValue(
      index: number,
      optValue: string,
      notify: boolean,
  ): Promise<boolean>

  Sets the value of an option at a specified index in the form field.

  Parameters

  • index: number

    The index of the option to set.
  • optValue: string

    The value to set for the option.
  • notify: boolean

    Whether to notify changes.

  Returns Promise<boolean>

  • Returns true if the option value was set successfully, otherwise false.

setValue

• setValue(value: string, notify: boolean): Promise<boolean>

  set field value

  Parameters

  • value: string

    The value to set for the form field
  • notify: boolean

    Whether to notify changes

  Returns Promise<boolean>

  • Returns true if the value was set successfully, otherwise false

Staticcreate

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

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

  Parameters

  • Optionaloptions: Options

  Returns Promise<FormFieldType>

  Create a FormField instance

  Example

  const formField = await FormField.create();
  Copy