Interface Entity

attributes

addOnPostSave

• addOnPostSave(handler): void

• Adds a function to be called after the OnSave is complete.

  Parameters

  • handler: PostSaveEventHandler

    The handler.

  Returns void

  Remarks

  Added in 9.2

  See

  External Link: PostSave Event Documentation

addOnSave

• addOnSave(handler): void

• Adds a handler to be called when the record is saved.

  Parameters

  • handler: SaveEventHandler | SaveEventHandlerAsync

    The handler.

  Returns void

getDataXml

• getDataXml(): string

• Gets an serialized-XML string representing data that will be passed to the server upon saving the record.

  Returns string

  The XML in string format.

  Remarks

  This function does not work with Microsoft Dynamics CRM for tablets.

  Example

  "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425
           555-1234</telephone2></account>".
  Copy

getEntityName

• getEntityName(): string

• Gets entity's logical name.

  Returns string

  The logical name.

getEntityReference

• getEntityReference(): Xrm.LookupValue

• Gets a lookup value that references the record.

  Returns Xrm.LookupValue

  A lookup value that references the record.

  See

  External Link: getEntityReference API Documentation

getId

• getId(): string

• Gets the record's unique identifier.

  Returns string

  The identifier, in Guid format.

  Example

  Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
  Copy

getIsDirty

• getIsDirty(): boolean

• Gets a boolean value indicating whether the record has unsaved changes.

  Returns boolean

  true if there are unsaved changes, otherwise false.

getPrimaryAttributeValue

• getPrimaryAttributeValue(): string

• Gets the record's primary attribute value.

  Returns string

  The primary attribute value.

  Remarks

  The value for this attribute is used when links to the record are displayed.

isValid

• isValid(): boolean

• Gets a boolean value indicating whether all of the entity data is valid.

  Returns boolean

  true if all of the entity data is valid; false otherwise.

removeOnPostSave

• removeOnPostSave(handler): void

• Parameters

  • handler: PostSaveEventHandler

  Returns void

  See

  External Link: removeOnPostSave (Client API reference)

removeOnSave

• removeOnSave(handler): void

• Removes the handler from the "on save" event.

  Parameters

  • handler: SaveEventHandler | SaveEventHandlerAsync

    The handler.

  Returns void

save

• save(): void

• Saves the record synchronously with the options to close the form or open a new form after the save is completed.

  Returns void

  Remarks

  When using quick create forms in the web application the saveandnew option is not applied. It will always work as if saveandclose were used. Quick create forms in Microsoft Dynamics CRM for tablets will apply the saveandnew behavior.

  Deprecated

  Deprecated in v9.1; This method is deprecated and we recommend to use the formContext.data.save method.

• save(saveMode?): void

• Saves the record with the given save mode.

  Parameters

  • Optional saveMode: Xrm.EntitySaveMode

    (Optional) the save mode to save, as either "saveandclose" or "saveandnew". If no parameter is included in the method, the record will simply be saved.

  Returns void