SpreadJS 13
GC.Spread.Sheets.Comments Namespace / Comment class / commentState Method
The state of the comment.
In This Topic
    commentState Method
    In This Topic
    Gets or sets the state of the comment.
    Syntax
    var instance = new GC.Spread.Sheets.Comments.Comment(text);
    var returnValue; // Type: any
    returnValue = instance.commentState(value);
    function commentState( 
       value : CommentState
    ) : any;

    Parameters

    value
    The state of the comment.

    Return Value

    If no value is set, returns the state of the comment; otherwise, returns the comment.
    Example
    This example gets the comment state.
    var comment = new GC.Spread.Sheets.Comments.Comment();
    comment.text("new comment!");
    comment.backColor("yellow");
    comment.foreColor("green");
    comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
    activeSheet.getCell(5,5).comment(comment);
    alert(comment.commentState());
    See Also

    Reference

    Comment class
    SpreadJS~GC.Spread.Sheets.CommentState