formContext.data (Client API reference)

Provides properties and methods to work with the data on a form.

formContext Data object model

Properties

Name Description
attributes Collection of non-table data on the form. Items in this collection are of the same type as the columns collection, but they are not columns of the form table.
More information: Collections
entity Provides methods to retrieve information specific to the record displayed on the page, the save method, and a collection of all the columns included on the form. Column data is limited to columns represented on the form.
More information: formContext.data.entity
process Provides objects and methods to interact with the business process flow data on a form.
More information: formContext.data.process

Note

Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.

Methods

Name Description
addOnLoad Adds a function to be called when form data is loaded.
getIsDirty Gets a boolean value indicating whether the form data has been modified.
isValid Gets a boolean value indicating whether all of the form data is valid. This includes the main table and any unbound columns. If the form has empty, required columns on it, control-level error notifications is shown.
refresh Asynchronously refreshes and optionally saves all the data of the form without reloading the page. The form data onload event occurs after the data is refreshed.
removeOnLoad Removes a function to be called when form data is loaded.
save Saves the record asynchronously with the option to set callback functions to be executed after the save operation is completed.

formContext.data.entity

formContext.data.process

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).