dojo.addOnUnload

Status:Draft Version:1.0 Available:since V?

Contents

• dojo.addOnUnload
  • Introduction
  • Usage
  • Examples
  • See also

dojo.addOnUnload registers a function to be called when the page unloads.

Introduction

Since working with the DOM or JavaScript during a window.onunload event is not recommended, dojo.addOnUnload is triggered during window.onbeforeunload. However, you need to be careful about what work you do during dojo.addOnUnload/window.onbeforeunload since this event can be triggered if the user clicks a link to download a file or a javascript: link. In these cases, the document will not be destroyed and so any destructive operations done during a dojo.addOnUnload callback may be premature. If you need to run code during window.onunload then you can register a function using dojo.addOnWindowUnload.

Usage

<script type="text/javascript">
  // declare a function to do the unload work
  var unLoad = function() {
    // do some unload stuff
    alert("unloading...");
  }
  // pass a function pointer
  dojo.addOnUnload(unLoad);

  // call a method of an object
  dojo.addOnUnload(window, "unLoad");

  // pass an object and an anonymous function
  dojo.addOnUnload(window, function() {alert("we're out of here!");});
</script>

Examples

This example demonstrates how a javascript: link will trigger a dojo.addOnUnload.

<script type="text/javascript">
  // declare a function to do the unload work
  var unLoad = function() {
    // do some unload stuff
    alert("unloading...");
  }
  // pass a function pointer
  dojo.addOnUnload(unLoad);
</script>

<script type="text/javascript"> // declare a function to do the unload work var unLoad = function() { // do some unload stuff alert("unloading..."); } // pass a function pointer dojo.addOnUnload(unLoad); </script>

This <a href="javascript:unLoad()">link</a> has an <pre>href="javascript:unLoad()"</pre> which fires dojo.addOnUnload but won't destroy the page.

This <a href="javascript:unLoad()">link</a> has an <pre>href="javascript:unLoad()"</pre> which fires dojo.addOnUnload but won't destroy the page.

See also

• dojo.addOnWindowUnload

Table of Contents

• dojo.addOnUnload
  • Introduction
  • Usage
  • Examples
  • See also