Class Page

page related properties and methods

Hierarchy

  • Page

Constructors

constructor

Methods

addEventListener get getFormCt navigate navigateToNextPage removeEventListener scrollTo updateFormElementsDictionary

Constructors

constructor

Methods

Static addEventListener

  • Add an event listener to the form page.

    Parameters

    • type: "sectionRendered" | "rendered" | "viewrendered" | "disposed" | "resized" | "scrolled" | "navigated" | "formStatusChanged" | "navigatedAway"

      Type of the event listener, defined in the PageEventsEnum.

    • callback: ((ev: any) => void)

      A callback function

        • (ev: any): void

        • Parameters

          • ev: any

          Returns void

    Returns void

Static get

  • Gets the current form page.

    Returns Page

Static getFormCt

  • Returns HTMLElement

Static navigate

  • Navigates to a page of the form page.

    Parameters

    • id: string

      html element id

    Returns void

Static navigateToNextPage

  • Navigates to next page of the form page depending of given condition. If condition is 'fullfilled' the next editable page is navigated to. If condition is 'visible' the next visible page is navigated to.

    Parameters

    • Optional condition: NextPageConditionEnum

      define if next page is navigated to depending of fullfilled or visible condition.

    Returns void

Static removeEventListener

  • Always remove previously registered event listeners!

    Parameters

    • type: "sectionRendered" | "rendered" | "viewrendered" | "disposed" | "resized" | "scrolled" | "navigated" | "formStatusChanged" | "navigatedAway"

      Type of the event listener, defined in the PageEventsEnum.

    • callback: ((ev: any) => void)

      A callback function.

        • (ev: any): void

        • Parameters

          • ev: any

          Returns void

    Returns void

Static scrollTo

  • Scroll to a html element on the page.

    Parameters

    • element: HTMLElement
    • duration: number = 200

      the duration of the scrolling, default = 200;

    Returns void

Static updateFormElementsDictionary

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc