formContext.data.entity (Client API reference)

Applies to Dynamics 365 for Customer Engagement apps version 9.x

Provides properties and methods to retrieve information specific to the record displayed on the page, the save method, and a collection of all the attributes included in the form. Attribute data is limited to attributes represented by fields on the form.

Properties

Name Description
attributes Collection of attributes for a record displayed on the form.
More information: Collections and Attributes.

Methods

Name Description
addOnSave Adds a function to be called when the record is saved.
getDataXml Returns a string representing the XML that will be sent to the server when the record is saved. Only data in fields that have changed are set to the server.
getEntityName Returns a string representing the logical name of the entity for the record.
getEntityReference Returns a lookup value that references the record.
getId Returns a string representing the GUID value for the record.
getIsDirty Gets a boolean value indicating whether any fields in the form have been modified.
getPrimaryAttributeValue Gets a string for the value of the primary attribute of the entity.
isValid Gets a boolean value indicating whether all of the entity data is valid.
removeOnSave Removes a function to be called when form data is loaded.
save Saves the record synchronously with the options to close the form or open a new form after the save is completed.

Understand Xrm object model

Controls (Client API reference)