Interface Data

attributes

entity

process

addOnLoad

• addOnLoad(handler): void

• Adds a function to be called when form data is loaded.

  Parameters

  • handler: DataLoadEventHandler

    The function to be executed when the form data loads. The function will be added to the bottom of the event handler pipeline.

  Returns void

getIsDirty

• getIsDirty(): boolean

• Gets a boolean value indicating whether the form data has been modified.

  Returns boolean

  Returns true if the form data has changed; false otherwise.

isValid

• isValid(): boolean

• Gets a boolean value indicating whether all of the form data is valid. This includes the main entity and any unbound attributes.

  Returns boolean

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

refresh

• refresh(save): PromiseLike<undefined>

• Asynchronously refreshes data on the form, without reloading the page.

  Parameters

  • save: boolean

    true to save the record, after the refresh.

  Returns PromiseLike<undefined>

  Returns an asynchronous promise.

removeOnLoad

• removeOnLoad(handler): void

• Removes a function to be called when form data is loaded.

  Parameters

  • handler: Xrm.Events.ContextSensitiveHandler

    The function to be removed when the form data loads.

  Returns void

save

• save(): PromiseLike<undefined>

• Asynchronously saves the record.

  Returns PromiseLike<undefined>

  Returns an asynchronous promise.
• save(saveOptions): PromiseLike<undefined>

• Asynchronously saves the record with the option to set callback functions to be executed after the save operation is completed.

  Parameters

  • saveOptions: SaveOptions

    Options to control how appointment, recurring appointment, or service activity records are processed.

  Returns PromiseLike<undefined>

  Returns an asynchronous promise.