Class InterForm

constructor

• new InterForm(options?: Options): InterForm

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

  Parameters

  • Optionaloptions: Options

  Returns InterForm

  Example

  const interForm = await InterForm.create();
  Copy

options

getAllFieldNames

• getAllFieldNames(): Promise<string[]>

  获取交互表单中的所有字段名称。

  Returns Promise<string[]>

  • 一个 Promise，解析为包含所有字段名称的数组。

getDoc

• getDoc(): Promise<null | DocType>

  获取与交互表单关联的文档。

  Returns Promise<null | DocType>

  • 一个解析为文档对象的 Promise。

getField

• getField(index: number, fieldName?: string): Promise<null | FormFieldType>

  从交互表单中按索引和名称获取特定字段。

  Parameters

  • index: number

    要检索的字段索引。
  • fieldName: string = ''

    要检索的字段名称。如果未提供，则默认为空字符串。

  Returns Promise<null | FormFieldType>

  • 一个解析为字段对象的 Promise。

getFieldsCount

• getFieldsCount(fieldName?: string): Promise<number>

  获取交互表单的字段数量。

  Parameters

  • fieldName: string = ''

    要统计的字段名称。

  Returns Promise<number>

  • 具有指定名称的字段数量。

getPageControl

• getPageControl(page: PageType, index: number): Promise<null | FormControlType>

  按索引获取页面上的特定控件。

  Parameters

  • page: PageType

    要从中获取控件的页面。
  • index: number

    要检索的控件索引。

  Returns Promise<null | FormControlType>

  • 一个解析为表单控件对象的 Promise。

getPageControlsCount

• getPageControlsCount(page: PageType): Promise<number>

  获取特定页面上的控件数量。

  Parameters

  • page: PageType

    要统计控件数量的页面。

  Returns Promise<number>

  • 一个 Promise，对应页面上控件数量的解析结果。

Staticcreate

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

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

  Parameters

  • Optionaloptions: Options

  Returns Promise<InterFormType>

  创建一个 InterForm 实例

  Example

  const interForm = await InterForm.create();
  Copy