registerVisualTool Method

In This Topic

Registers the visual tool type.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.WebDocumentViewerBaseJS(settings);

var value; // Type: any

// Parameters
var id; // Type: string
var visualTool; // Type: WebVisualToolJS

value = instance.registerVisualTool(id, visualTool);

function registerVisualTool(
   idThe identifier of visual tool type.
 : string, 
   visualToolWebVisualToolJS object.
 : WebVisualToolJS
) : any;

Parameters

id: The identifier of visual tool type.
visualTool: WebVisualToolJS object.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.
	Thrown if ID is empty string.
	Thrown if document viewer contains standard registered tool with the same ID (WebDocumentViewerBaseJS.getAllStandardRegisteredVisualToolIds).

Browser Compatibility

56+

45+

Reference

WebDocumentViewerBaseJS Class
WebDocumentViewerBaseJS Members

Send Feedback