Save event arguments (client-side reference)

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

In the save event you can use the execution context object getEventArgs method to retrieve an object that contains methods you can use to manage the save event.

Save Event Argument Methods

• getSaveMode
  Returns a value indicating how the save event was initiated by the user.

• isDefaultPrevented
  Returns a value indicating whether the save event has been canceled because the preventDefault method was used in this event hander or a previous event handler.

• preventDefault
  Cancels the save operation, but all remaining handlers for the event will still be executed.

getSaveMode

Returns a value indicating how the save event was initiated by the user.

execObj.getEventArgs().getSaveMode()

• Return Value
  Type: Number

  The following table describes the supported values returned to detect different ways entity records may be saved by the user.

  Entity	Event Mode	Value
  All	Save	1
  All	Save and Close	2
  All	Save and New	59
  All	AutoSave	70
  Activities	Save as Completed	58
  All	Deactivate	5
  All	Reactivate	6
  User or Team owned entities	Assign	47
  Email (E-mail)	Send	7
  Lead	Qualify	16
  Lead	Disqualify	15

• Remarks
  This method is essential if you want to enable auto-save for most forms in an organization but disable it for specific forms. The following code registered for the onSave event with the execution context passed to it will prevent any saves that initiate from an auto-save but allow all others. With auto-save enabled, navigating away is equivalent to Save and Close. This code will prevent any saves that are initiated by the 30 second timer or when people navigate away from a form with unsaved data.

  function preventAutoSave(econtext) {
      var eventArgs = econtext.getEventArgs();
      if (eventArgs.getSaveMode() == 70 || eventArgs.getSaveMode() == 2) {
          eventArgs.preventDefault();
      }
  }
  

  To save a record the user must click the Save icon at the bottom of the form or a custom Save command needs to be added to the command bar.

isDefaultPrevented

Returns a value indicating whether the save event has been canceled because the preventDefault method was used in this event hander or a previous event handler.

execObj.getEventArgs().isDefaultPrevented()

• Return Value
  Type: Boolean

preventDefault

Cancels the save operation, but all remaining handlers for the event will still be executed.

execObj.getEventArgs().preventDefault()

See Also

Client-side programming reference
Collections (client-side reference)
Form scripting quick reference
Execution context (client-side reference)
getEventArgs
Write code for Microsoft Dynamics 365 forms
Use the Xrm.Page object model

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright