Interface IFormApi

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

Hierarchy (view full)

Methods

applyTheme empty getField getFieldBy getFieldByInternalLabel getFields getPagingContext getSection getSections isRendered 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

    • Optional predicate: ((section) => boolean)
        • (section): boolean

        • Parameters

          • section: any

          Returns boolean

    Returns any[]

isRendered

  • isRendered(): 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

Theme

On This Page

applyThemeemptygetFieldgetFieldBygetFieldByInternalLabelgetFieldsgetPagingContextgetSectiongetSectionsisRenderednotifyFormEventListenersregisterFormEventListenerresetsetValuesunregisterFormEventListener