onBeforeUnload

This method is called before the browser page is closed. It can be used to handle any kind of actions that should be performed before the browser’s onbeforeunload event is fired.

Your extending Application class can override this method, and include custom functionality as required.

If a value other than ’undefined’ is returned from this method, the browser displays a confirmation dialog containing a message like the following:

The extending method may call the this.jsxsuper() method to include the base functionality. The base method calls isWorkItemPreviewFormOpen(false) to check for any work items open in a preview pane. If so, it returns the value of the dynamic property, txtWorkItemChanged.

Syntax

onBeforeUnload();

Parameters

none

Returns

  • undefined or string
    • if undefined, the browser window is closed, unless there is another handler that returns a value other than undefined.
    • if a string, it is displayed in the confirmation dialog.