Interface InterFormType

interface InterFormType {
    getAllFieldNames: () => Promise<string[]>;
    getDoc: () => Promise<null | DocType>;
    getField: (
        index: number,
        fieldName: string,
    ) => Promise<null | FormFieldType>;
    getFieldsCount: (fieldName: string) => Promise<number>;
    getPageControl: (
        page: PageType,
        index: number,
    ) => Promise<null | FormControlType>;
    getPageControlsCount: (page: PageType) => Promise<number>;
    options?: Options;
}

Implemented by

Properties

getAllFieldNames getDoc getField getFieldsCount getPageControl getPageControlsCount options?

Properties

getAllFieldNames

getAllFieldNames: () => Promise<string[]>

Gets all field names from the inter form.

Type declaration

    • (): Promise<string[]>

    • 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.

Type declaration

    • (): Promise<null | DocType>

    • 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.

Type declaration

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

    • 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.

Type declaration

    • (fieldName: string): Promise<number>

    • 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.

Type declaration

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

    • 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.

Type declaration

    • (page: PageType): Promise<number>

    • 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.

Optionaloptions

options?: Options

Settings

Member Visibility

On This Page

Properties