Skip to content

Interface: IContext

Summary

Properties

Class Properties

Inherited Properties

Currently none inherited from the parent class(es).

Methods

Class Methods

Inherited Methods

Currently none inherited from the parent class(es).

Properties

binding?

optional binding?: any

provide a simple property access to the binding

clientAPI

▸ clientAPI: IClientAPI

Associated ClientAPI object

clientAPIProps

▸ clientAPIProps: IClientAPIProps

Associated IClientAPIProps object

clientData

▸ clientData: IClientData

Get the Get the client data object. This starts out as a plain JavaScript object, and can be modified to hold application state. Can only be accessed for IClientAPI instances associated with a UI element, because that guarantees that the data will last for the lifetime of that element.

element?

optional element?: any

This context's associated UI element object such as page, control, sectionedTable etc

isSectionedTableBackwardCompatible?

optional isSectionedTableBackwardCompatible?: boolean

A boolean to determine if the context is backward compatible with sectionedTable

• readLink: string

This context's binding's associated readLink if any. Otherwise undefined.

searchContext?

optional searchContext?: ISearchContext

Associated Search Context

Methods

resetClientAPIProps

▸ resetClientAPIProps(): void

Delete all relevant properties from the clientAPIProps object.

Returns: void