set Method

In This Topic

Replaces an annotation comment at the specified index.

Syntax

var instance = new Vintasoft.Imaging.Annotation.UI.WebAnnotationCommentCollectionJS(parent);

var value; // Type: any

// Parameters
var index; // Type: number
var comment; // Type: WebAnnotationCommentJS

value = instance.set(index, comment);

function set(
   indexThe zero-based index of the annotation comment that should be replaced.
 : number, 
   commentNew WebAnnotationCommentJS at the specified index.
 : WebAnnotationCommentJS
) : any;

Parameters

index: The zero-based index of the annotation comment that should be replaced.
comment: New WebAnnotationCommentJS at the specified index.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.
	Thrown if index is less than zero or index is equal to or greater than collection length.
	Thrown if comment already exists in collection.

Browser Compatibility

56+

45+

Reference

WebAnnotationCommentCollectionJS Class
WebAnnotationCommentCollectionJS Members

Send Feedback