DocuVieware Reference Guide
RegisterOnAnnotationAdded
Reference Guides > JavaScript API > Events > RegisterOnAnnotationAdded
 RegisterOnAnnotationAdded

This function allows you trigger a function of your own when an annotation has been added.

RegisterOnAnnotationAdded: function (docuViewareID, callback)

Parameters

docuViewareID
The identifier for the DocuVieware™ instance.
callback
The function you want to execute on event.
The callback provides an argument having a prototype { id, pageNo }.
- id specifies the annotation unique id that can be retrieved from the server side using the Guid property of the annotation class.
- pageNo is the page number the annotation has been added on.

Return Value

1 if error.

Example of usage

This JavaScript makes sure the DocuVieware control is properly loaded and initialized and then subscribes to the event on load to display the corresponding annotation id and page in the console.

function RegisterOnAnnotationAddedOnDocuViewareAPIReady() {
   if (typeof DocuViewareAPI !== "undefined" && DocuViewareAPI.IsInitialized("DocuVieware1")) {
      DocuViewareAPI.RegisterOnAnnotationAdded("DocuVieware1", function (annot) {
         console.log(annot);
      });
   }
   else {
      setTimeout(function () { RegisterOnAnnotationAddedOnDocuViewareAPIReady() }, 10);
   }
}
window.onload = function () {
   RegisterOnAnnotationAddedOnDocuViewareAPIReady();
}