locked Method

Gets or sets the locked setting for the comment.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.Comments.Comment(text);
var returnValue; // Type: any
returnValue = instance.locked(value);

function locked( 
   value : boolean
) : any;

Parameters

value: The locked setting for the comment.

Return Value

If no value is set, returns the locked setting for the comment; otherwise, returns the comment.

Example

This example uses the locked method.

Javascript

var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.lockText(false);
comment.locked(false);
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.options.isProtected = true;
activeSheet.getCell(5,5).comment(comment);

Reference

Comment class