Interface ControlPageEventsApi

Equivalent to PageEventsApiBase with the exception that event hooks will be scoped to the page on which the calling control resides.

interface ControlPageEventsApi {
getPageEvent(eventName: SaveObject): undefined | IPageEvent<IPageEventData>;
getPageEvent<T>(eventName: string): undefined | IPageEvent<T>;
}

Hierarchy (view full)

PageEventsApiBase
- ControlPageEventsApi

Index

Methods

Methods

getPageEvent

getPageEvent(eventName): undefined | IPageEvent<IPageEventData>
Parameters
- eventName: SaveObject
  The name of the event.
Returns undefined | IPageEvent<IPageEventData>
The reference to the hookable page event.

Method
Description
Get a reference to a hookable page event if it is defined.

Inherited from PageEventsApiBase.getPageEvent
getPageEvent<T>(eventName): undefined | IPageEvent<T>
Type Parameters
- T extends IPageEventData
Parameters
- eventName: string
Returns undefined | IPageEvent<T>
Inherited from PageEventsApiBase.getPageEvent