Reference Guide
Reference Guides / JavaScript API / Events / RegisterOnAnnotationEdited
In This Topic
    In This Topic

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

    RegisterOnAnnotationEdited: function (docuViewareID, callback)


    The identifier for the DocuVieware™ instance.
    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 of the annotation that has been edited.

    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 RegisterOnAnnotationEditedOnDocuViewareAPIReady() {
        if (typeof DocuViewareAPI !== "undefined" && DocuViewareAPI.IsInitialized("DocuVieware1")) {
            DocuViewareAPI.RegisterOnAnnotationEdited("DocuVieware1", function (annot) { console.log(; });
        else {
            setTimeout(function () { RegisterOnAnnotationEditedOnDocuViewareAPIReady() }, 10);
    document.addEventListener("DOMContentLoaded", function () {
    }, false);