Interface IFormApi

interface IFormApi {
    applyTheme(theme: any): void;
    empty(): Promise<void>;
    getField(fieldId: any): TFieldApiUnion;
    getFieldBy(predicate: ((field: IFieldApi) => boolean)): TFieldApiUnion;
    getFieldByInternalLabel(internalLabel: string): TFieldApiUnion;
    getFields(predicate?: ((field: IFieldDto) => boolean)): IFieldApi[];
    getPagingContext(): IPagingContext;
    getSection(sectionId: any): ISectionApi;
    getSections(predicate?: ((section: any) => boolean)): any[];
    getSubmissionJSON(): IValidateFormSubmissionDto;
    isRendered(): boolean;
    isWithErrors(): boolean;
    notifyFormEventListeners(type: FormEvents, data: any): Promise<any>;
    registerFormEventListener(listener: IFormEventListener): void;
    reset(): Promise<void>;
    setValues(values: {
        [fieldId: string]: IFieldValueUnion;
    }): Promise<void>;
    unregisterFormEventListener(listener: IFormEventListener): void;
}

Hierarchy (view full)

Methods

applyTheme empty getField getFieldBy getFieldByInternalLabel getFields getPagingContext getSection getSections getSubmissionJSON isRendered isWithErrors notifyFormEventListeners registerFormEventListener reset setValues unregisterFormEventListener

Methods

applyTheme

  • applyTheme(theme): void

  • Parameters

    • theme: any

    Returns void

empty

  • empty(): Promise<void>

  • Returns Promise<void>

getField

getFieldBy

getFieldByInternalLabel

getFields

getPagingContext

getSection

getSections

  • getSections(predicate?): any[]

  • Parameters

    • Optionalpredicate: ((section: any) => boolean)
        • (section): boolean

        • Parameters

          • section: any

          Returns boolean

    Returns any[]

getSubmissionJSON

  • getSubmissionJSON(): IValidateFormSubmissionDto

  • Returns IValidateFormSubmissionDto

isRendered

  • isRendered(): boolean

  • Returns boolean

isWithErrors

  • isWithErrors(): boolean

  • Returns boolean

notifyFormEventListeners

  • notifyFormEventListeners(type, data): Promise<any>

  • Parameters

    Returns Promise<any>

registerFormEventListener

  • registerFormEventListener(listener): void

  • Parameters

    Returns void

reset

  • reset(): Promise<void>

  • Returns Promise<void>

setValues

unregisterFormEventListener

  • unregisterFormEventListener(listener): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Methods