CommentRemoving Event

Occurs when the user is removing any comment.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance; // Type: Events
instance.CommentRemoving = function(sheet, sheetName, comment, cancel) { };

CommentRemoving = function ( 
   sheet : Sheet,
   sheetName : string,
   comment : Comment,
   cancel : boolean
) { };

Parameters

sheet: The sheet that triggered the event.
sheetName: The sheet's name.
comment: The comment is being removed.
cancel: A value that indicates whether the operation should be canceled.

Example

This example prevents the comment from being removed.

Javascript

var comment = new GcSpread.Sheets.Comment();
comment.text("new comment!");
comment.backColor("orange");
comment.displayMode(GcSpread.Sheets.DisplayMode.AlwaysShown);
activeSheet.setComment(5,5,comment);

$("#spreadContainer").data("spread").getActiveSheet().bind(GcSpread.Sheets.Events.CommentRemoving, function (e, info) {    
      info.cancel = true;
});

Reference

Events type