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

This function allows you trigger a function of your own when the built-in Annotations Snap-In is selected.

RegisterOnAnnotationsSnapInSelected: function (docuViewareID, callback)

Parameters

docuViewareID
The identifier for the DocuVieware™ instance.
callback
The function you want to execute on event.

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.

function RegisterOnAnnotationsSnapInSelectedOnDocuViewareAPIReady() {
    if (typeof DocuViewareAPI !== "undefined" && DocuViewareAPI.IsInitialized("DocuVieware1")) {
        DocuViewareAPI.RegisterOnAnnotationsSnapInSelected("DocuVieware1", function () { console.log("annotations snap-in selected"); });
    }
    else {
        setTimeout(function () { RegisterOnAnnotationsSnapInSelectedOnDocuViewareAPIReady() }, 10);
    }
}
document.addEventListener("DOMContentLoaded", function () {
    RegisterOnAnnotationsSnapInSelectedOnDocuViewareAPIReady();
}, false);