getTool Method

In This Topic

Returns the visual tool at the specified index.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.VisualTools.WebCompositeVisualToolJS(visualTools);

var value; // Type: Vintasoft.Imaging.UI.VisualTools.WebVisualToolJS

// Parameters
var index; // Type: number

value = instance.getTool(index);

function getTool(
   indexZero-based index of visual tools.
 : number
) : WebVisualToolJS;

Parameters

index: Zero-based index of visual tools.

Return Value

WebVisualToolJS object.

Exceptions

Exception	Description
	Thrown if argument has wrong type.
	Thrown if index is less than zero or index is greater than visual tools collection length.

Browser Compatibility

56+

45+

Reference

WebCompositeVisualToolJS Class
WebCompositeVisualToolJS Members

Send Feedback