Interface: IContext¶
Hierarchy¶
- IContext
Implemented by¶
Summary¶
Properties¶
Class Properties¶
- binding
- clientAPI
- clientAPIProps
- clientData
- element
- isSectionedTableBackwardCompatible
- readLink
- searchContext
Inherited Properties¶
Currently none inherited from the parent class(es).
Methods¶
Class Methods¶
Inherited Methods¶
Currently none inherited from the parent class(es).
Properties¶
Optional binding¶
• 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.
Optional element¶
• element? : any
This context's associated UI element object such as page, control, sectionedTable etc
Optional isSectionedTableBackwardCompatible¶
• isSectionedTableBackwardCompatible? : boolean
A boolean to determine if the context is backward compatible with sectionedTable
readLink¶
• readLink: string
This context's binding's associated readLink if any. Otherwise undefined.
Optional searchContext¶
• searchContext? : ISearchContext
Associated Search Context
Methods¶
resetClientAPIProps¶
▸ resetClientAPIProps(): void
Delete all relevant properties from the clientAPIProps object.
Returns: void