Interface SaveEventArgumentsAsync

Interface for save event arguments.

Hierarchy

Methods

disableAsyncTimeout getSaveMode isDefaultPrevented preventDefault preventDefaultOnError

Methods

disableAsyncTimeout

  • Returns void

    Summary

    Call to prevent default 10 second timeout in async OnSave event handlers.

    Description

    When using an async save the handler will wait for the promise to be fulfilled. To ensure that a save completes in a timely manner the handler throws a timeout exception after 10 seconds to let you know to tune the async OnSave event for better performance. When the disableAsyncTimeout is set, the timeout for that handler will not be applied. It will continue to wait for that handler's promise to be fulfilled. This should be used with caution as it might affect the performance of the form save.

    See

    External Link: Async onSave timeouts

getSaveMode

  • Returns XrmEnum.SaveMode

    The save mode.

    Summary

    Gets save mode, as an integer.

    Description

    Gets save mode, as an integer.
    Values returned are:

    • 1 Save
    • 2 Save and Close
    • 59 Save and New
    • 70 AutoSave (Where enabled; can be used with an OnSave handler to conditionally disable auto-saving)
    • 58 Save as Completed (Activities)
    • 5 Deactivate
    • 6 Reactivate
    • 47 Assign (All user- or team-owned entities)
    • 7 Send (Email)
    • 16 Qualify (Lead)
    • 15 Disqualify (Lead)

isDefaultPrevented

  • Returns a boolean value to indicate if the record's save has been prevented.

    Returns boolean

    true if saving is prevented, otherwise false.

preventDefault

  • Prevents the save operation from being submitted to the server. All remaining "on save" handlers will continue execution.

    Returns void

preventDefaultOnError

  • Cancels the save operation if the event handler has a script error, returns a rejected promise for an async event handler or the operation times out.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc