Class FormField

constructor

• new FormField(options?: Options): FormField

  不再使用 'new' 来创建，请改用 create。

  Parameters

  • Optionaloptions: Options

  Returns FormField

  Example

  const formField = await FormField.create();
  Copy

options

checkControl

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

  检查表单字段中控件的状态。

  Parameters

  • controlIndex: number

    要检查的控件索引。
  • checked: boolean

    控件是否应被选中。
  • notify: boolean

    是否通知变更。

  Returns Promise<boolean>

  • 如果成功检查控件状态则返回 true，否则返回 false。

getAlternateName

• getAlternateName(): Promise<string>

  获取备用名称

  Returns Promise<string>

  • 返回表单字段的备用名称

getControlByIndex

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

  通过索引获取控件

  Parameters

  • index: number

    要获取的控件索引

  Returns Promise<null | FormControlType>

  • 返回指定索引处的表单控件对象

getControlsCount

• getControlsCount(): Promise<number>

  获取控件数量

  Returns Promise<number>

  • 返回控件的数量

getFieldDict

• getFieldDict(): Promise<null | PDFDictionaryType>

  获取字段字典

  Returns Promise<null | PDFDictionaryType>

  • 返回字段字典对象

getFieldFlags

• getFieldFlags(): Promise<number>

  获取字段标志

  Returns Promise<number>

  • 返回字段标志的数字值

getFieldType

• getFieldType(): Promise<number>

  获取字段类型

  Returns Promise<number>

  • 返回字段类型的数字

getFullName

• getFullName(): Promise<string>

  获取全名

  Returns Promise<string>

  • 返回表单字段的全名

getInterForm

• getInterForm(): Promise<null | InterFormType>

  获取 InterForm

  Returns Promise<null | InterFormType>

  • 返回 InterForm 对象

getOptionsCount

• getOptionsCount(): Promise<number>

  获取表单字段中选项的数量。

  Returns Promise<number>

  • 返回表单字段中选项的数量。

insertOption

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

  在指定索引位置向表单字段中插入一个选项。

  Parameters

  • optLabel: string

    要插入的选项标签。
  • index: number

    插入选项的位置索引。
  • notify: boolean

    是否通知变更。

  Returns Promise<number>

  • 返回插入选项的索引。

setAlternateName

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

  设置备用名称

  Parameters

  • name: string

    要为表单字段设置的备用名称

  Returns Promise<void>

  • 无返回值

setFieldFlags

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

  设置字段标志

  Parameters

  • flags: number

    要为表单字段设置的标志

  Returns Promise<void>

  • 无返回值

setOptionValue

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

  设置表单字段中指定索引处选项的值。

  Parameters

  • index: number

    要设置的选项索引。
  • optValue: string

    要为该选项设置的值。
  • notify: boolean

    是否通知变更。

  Returns Promise<boolean>

  • 如果选项值设置成功则返回 true，否则返回 false。

setValue

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

  设置字段值

  Parameters

  • value: string

    要为表单字段设置的值
  • notify: boolean

    是否通知变更

  Returns Promise<boolean>

  • 如果值设置成功则返回 true，否则返回 false

Staticcreate

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

  不再使用 'new' 来创建，而是使用 create 代替。

  Parameters

  • Optionaloptions: Options

  Returns Promise<FormFieldType>

  创建一个 FormField 实例

  Example

  const formField = await FormField.create();
  Copy