Form OnSave Event (Client API reference) in model-driven apps

The OnSave event occurs when:

  • The user clicks the Save icon in the lower right corner of the form, even when there is no changed data to be saved.
  • Code executes the formContext.data.entity.save method, even when there is no changed data to be saved.
  • The user navigates away from the form and there is unsaved data in the form.
  • The auto-save option is enabled, 30 seconds after data has changed and there is unsaved data in the form.
  • Code executes the formContext.data.save method and there is unsaved data in the form.
  • Code executes the formContext.data.refresh method passing a true value as the first parameter and there is unsaved data in the form.

To determine which button was clicked to perform the save, use the getSaveMode method.

You can cancel the save action by using the preventDefault method within the event arguments object. The preventDefault method which is accessible by using the getEventArgs method that is part of the execution context. Execution context is automatically passed to the form event handler.

Note

OnSave events are synchronous. You should not use asynchronous code in an OnSave event handler that needs an action to be taken or handled on the resolution of the async code. This causes issues if the resolution handler expects the app context to remain the same as it was when the asynchronous code was started.

For example, there may be code in an OnSave event handler to make a network request, stop the form save (using the preventDefault method), and then close the form if the request is successful. Before the response from the request is receieved, the user may have navigated to a different page. In this case, the user may see an unexpected unsaved changes dialog from the page they are on when the response is received.

You should also not make synchronous network requests in an OnSave event handler. This can cause a slow save experience and an unresponsive app. Instead, if additional data is needed to determine whether a save should proceed or not, the requests should be made via the Microsoft Dataverse, for example with plug-ins or flows.

Grid OnSave Event