Interface LoadEventContext

Synchronous Form OnLoad event context. In the API documentation, this is sometimes referred to as the executionContext. Asynchronous version see LoadEventContextAsync Not to be confused with DataLoadEventContext

See

Hierarchy

Methods

getContext getDepth getEventArgs getEventSource getFormContext getSharedVariable setSharedVariable

Methods

getContext

getDepth

  • Gets the handler's depth, which is the order in which the handler is executed.

    Returns number

    The depth, a 0-based index.

getEventArgs

getEventSource

getFormContext

getSharedVariable

  • Type Parameters

    • T

      Generic type parameter.

    Parameters

    • key: string

      The key.

    Returns T

    The shared variable.

    Summary

    Gets the shared variable with the specified key.

    Description

    Gets the shared variable with the specified key. Used to pass values between handlers of an event.

setSharedVariable

  • Type Parameters

    • T

      Generic type parameter.

    Parameters

    • key: string

      The key.

    • value: T

      The value.

    Returns void

    Summary

    Sets a shared variable.

    Description

    Sets the shared variable with the specified key. Used to pass values between handlers of an event.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc