Class InterForm

constructor

• new InterForm(options?: Options): InterForm

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

  Parameters

  • Optionaloptions: Options

  Returns InterForm

  Example

  const interForm = await InterForm.create();
  Copy

options

getAllFieldNames

• getAllFieldNames(): Promise<string[]>

  Gets all field names from the inter form.

  Returns Promise<string[]>

  • A promise that resolves to an array of all field names.

getDoc

• getDoc(): Promise<null | DocType>

  Gets the document associated with the inter form.

  Returns Promise<null | DocType>

  • A promise that resolves to the document object.

getField

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

  Gets a specific field by index and name from the inter form.

  Parameters

  • index: number

    The index of the field to retrieve.
  • fieldName: string = ''

    The name of the field to retrieve. If not provided, it defaults to an empty string.

  Returns Promise<null | FormFieldType>

  • A promise that resolves to the field object.

getFieldsCount

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

  Gets the field count of the inter form.

  Parameters

  • fieldName: string = ''

    The name of the field to count.

  Returns Promise<number>

  • The count of fields with the specified name.

getPageControl

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

  Gets a specific control on a page by index.

  Parameters

  • page: PageType

    The page from which to get the control.
  • index: number

    The index of the control to retrieve.

  Returns Promise<null | FormControlType>

  • A promise that resolves to the form control object.

getPageControlsCount

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

  Gets the count of controls on a specific page.

  Parameters

  • page: PageType

    The page from which to count the controls.

  Returns Promise<number>

  • A promise that resolves to the count of controls on the page.

Staticcreate

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

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

  Parameters

  • Optionaloptions: Options

  Returns Promise<InterFormType>

  Create a InterForm instance

  Example

  const interForm = await InterForm.create();
  Copy