ModelDrivenFormIntegration control properties and actions

Canvas apps embedded on model-driven forms contain a special control named ModelDrivenFormIntegration. This control is responsible for bringing contextual data from the host model-driven form to the embedded canvas app.

This topic explains the properties and actions available on the ModelDrivenFormIntegration control.

Property or action Description
DataSource Should be set to the data source connected to the parent entity of the host model-driven form.
Automatically set when embedding a new canvas app.
Item Read-only property that enables the embedded canvas app to access the record from the host model-driven form.
As an example, to get the value of a field with the name accountnumber and display name Account Number, you can use ModelDrivenFormIntegration.Item.accountnumber or ModelDrivenFormIntegration.Item.'Account Number'.
OnDataRefresh The formula in this property is evaluated when the host model-driven form saves data.
Use it to refresh the data source connected to the parent entity of the host model-driven form and to perform other actions like setting or updating variables.
As an example, setting it to the formula below will refresh the Accounts data source and set a variable named CurrentAccountNumber to the value of the Account Number field of the current record.
Refresh(Accounts); Set(CurrentAccountNumber, ModelDrivenFormIntegration.Item.'Account Number')
RefreshForm Refreshes the data on the host model-driven form.
See Perform predefined actions on the host form for details.
SaveForm Saves the data on the host model-driven form.
See Perform predefined actions on the host form for details.
NavigateToMainForm Navigates the host model-driven form to a main form and displays the specified record.
See Perform predefined actions on the host form for details.
NavigateToView Navigates the host model-driven form to a view.
See Perform predefined actions on the host form for details.
OpenQuickCreateForm Opens the default quick create form for an entity.
See Perform predefined actions on the host form for details.
Data Read-only property used by the framework to send some key data from the host model-driven form to the embedded canvas app.
Do not use this property. Use Item to access the record from the host model-driven form.

See also

Embed a canvas app on a model-driven form
Add an embedded canvas app on a model-driven form
Edit a canvas app embedded on a model-driven form
Customize the screen size and orientation of a canvas app embedded on a model-driven form
Perform predefined actions on the host form from within an embedded canvas app
Share an embedded canvas app
Guidelines on working with embedded canvas apps
Migrating embedded canvas apps on model-driven forms created using the public preview release to latest