Page type

Important

The Finance and Operations (Dynamics 365) mobile app and platform have been deprecated. For more information, see Removed or deprecated platform features.

Page object type.

Hierarchy

Page

Index

Properties

Methods

Events

Properties

children

children: Control [ ]

(Read-only) The list of all direct children controls of the page.

dataLoadedInitially

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.

initialized

initialized: boolean

(Read-only) True if the page instance has been initialized.

metadata

metadata: PageMetadata

(Read-only) The page metadata.

metadataLoaded

metadataLoaded: Promise <void>

(Read-only) A promise which resolves when the metadata has finished loading.

pageContext

pageContext: string

The current page context.

pageFilter

pageFilter: DataFilter

The current filter applied on the page.

state

state: PageState

(Read-only) The current state of the page.

syncError

syncError: boolean

(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 article for a detailed explanation of page data synchronization.

syncPending

syncPending: boolean

(Read-only) True if the page's submission is waiting to be synced. Refer to this article for a detailed explanation of page data synchronization.

syncProcessing

syncProcessing: boolean

(Read-only) True if the page instance is currently syncing its submission. Refer to this article for a detailed explanation of page data synchronization.

syncUnitEditable

syncUnitEditable: boolean

(Read-only) True if it's possible to edit a submission while it's waiting to be synchronized. Refer to this article for a detailed explanation of page data synchronization.

title

title: string

(Read-only) The title of the page.

Methods

canSubmit

canSubmit(): boolean

Returns true if action page can be submitted and there are no validation/error messages.

Returns boolean

close

close(): void

Dispose the page instance and all its lifecycle events.

Returns void

getAction

getAction(actionName: string): PageLink

Get a page action by name. These include the actions in the action sheet/menu.

Parameters

Name Type Description
actionName string

getActions

getActions(): PageLink [ ]

Get all page actions. These include the actions in the action sheet/menu.

getControl

getControl(controlName: string): Control

Get a page control by name. It recursively searches through all its children pages.

Parameters

Name Type Description
controlName string

Returns Control

getDesign

getDesign(): Design

Get the design object associated with the page.

Returns Design

getEntityContext

getEntityContext(): EntityRef

Get current entity context.

Returns EntityRef

isEditable

isEditable(): boolean

Returns true if the page is an Action Page

Returns boolean

refreshData

refreshData(): Promise <void>

Force refresh page data.

Returns Promise <void>

resume

resume(): Promise <void>

Resume a temporarily suspended page.

Returns Promise <void>

submit

submit(): Promise <CompleteEventArgs>

Submit an Action.

Returns Promise <CompleteEventArgs>

suspend

suspend(): void

Temporarily suspend a page. For example, when the page is not the active view.

Returns void

Events

onClose

onClose: EventHook <null>

Event that is raised when a page is closed.

onComplete

onComplete: EventHook <any>

Event that is raised when an action is completed.

onDataLoaded

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

onInit: EventHook <any>

Event that fires when a page instance has been initialized, and the metadata has been loaded.

onPreInit

onPreInit: EventHook <any>

Event that fires when a page instance has been initialized. This is fired before the metadata has been loaded.

onRefresh

onRefresh: EventHook <null>

Event that fires on forced page refresh, before new data has been loaded.

onStateChange

onStateChange: EventHook <null>

Event that fires when the page state changes.

onSubmit

onSubmit: EventHook <PageSubmitArgs>

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

onSyncStatusChange: EventHook <null>

Event that fires when the page sync status changes.