Page object type.
children: Control [ ]
(Read-only) The list of all direct children controls of the page.
dataLoadedInitially: Promise <void>
(Read-only) A promise which resolves when the data has loaded for the first time. The promise continues to stay resolved for the rest of the page life.
(Read-only) True if the page instance has been initialized.
(Read-only) The page metadata.
metadataLoaded: Promise <void>
(Read-only) A promise which resolves when the metadata has finished loading.
The current page context.
The current filter applied on the page.
(Read-only) The current state of the page.
(Read-only) True if the page's submission is in error state. This normally happens when the server rejects submissions due to validation errors. Refer to this topic for a detailed explanation of page data synchronization.
(Read-only) True if the page's submission is waiting to be synced. Refer to this topic for a detailed explanation of page data synchronization.
(Read-only) True if the page instance is currently syncing its submission. Refer to this topic for a detailed explanation of page data synchronization.
(Read-only) True if it's possible to edit a submission while it's waiting to be synchronized. Refer to this topic for a detailed explanation of page data synchronization.
(Read-only) The title of the page.
Returns true if action page can be submitted and there are no validation/error messages.
Dispose the page instance and all its lifecycle events.
getAction(actionName: string): PageLink
Get a page action by name. These include the actions in the action sheet/menu.
getActions(): PageLink [ ]
Get all page actions. These include the actions in the action sheet/menu.
Returns PageLink [ ]
getControl(controlName: string): Control
Get a page control by name. It recursively searches through all its children pages.
Get the design object associated with the page.
Get current entity context.
Returns true if the page is an Action Page
refreshData(): Promise <void>
Force refresh page data.
Returns Promise <void>
resume(): Promise <void>
Resume a temporarily suspended page.
Returns Promise <void>
submit(): Promise <CompleteEventArgs>
Submit an Action.
Returns Promise <CompleteEventArgs>
Temporarily suspend a page. For example, when the page is not the active view.
onClose: EventHook <null>
Event that is raised when a page is closed.
onComplete: EventHook <any>
Event that is raised when an action is completed.
onDataLoaded: EventHook <any>
Event that fires when the page data has loaded. The event may be fired multiple times - every time new data is loaded.
onInit: EventHook <any>
Event that fires when a page instance has been initialized, and the metadata has been loaded.
onPreInit: EventHook <any>
Event that fires when a page instance has been initialized. This is fired before the metadata has been loaded.
onRefresh: EventHook <null>
Event that fires on forced page refresh, before new data has been loaded.
onStateChange: EventHook <null>
Event that fires when the page state changes.
Event that fires before an action is submitted. It can be intercepted for action validation/deferring Refer to IPageSubmitArgs to know more about the available options.
onSyncStatusChange: EventHook <null>
Event that fires when the page sync status changes.