概述
本 Demo 展示了如何使用 CommentChanged 事件监听批注属性的变化。Demo 通过代码修改批注的文本、背景色、前景色和显示模式,每次修改都会触发事件并在文本框中记录发生变化的属性名称。
实现思路
在单元格 (1, 1) 位置添加批注
绑定 CommentChanged 事件,监听批注的所有属性变化
通过代码修改批注的多个属性(text、backColor、foreColor、displayMode)来触发事件
在事件回调中将每次变化的属性名称显示到文本框中
代码解析
添加批注
使用 comments.add 方法在指定单元格添加批注,第一个参数是行号,第二个参数是列号,第三个参数是批注文本。同时设置单元格文本作为视觉提示。
绑定事件监听
绑定 CommentChanged 事件到工作表。当批注的任何属性发生变化时,事件回调会被触发,args.propertyName 返回发生变化的属性名称(如 text、backColor、foreColor、displayMode)。回调将属性名称追加到文本框中显示。
修改批注属性触发事件
通过 comments.get 方法获取批注对象,然后依次修改其属性。每次属性修改都会触发 CommentChanged 事件:
text() - 设置批注文本内容
backColor() - 设置批注框背景色
foreColor() - 设置批注文字颜色
displayMode() - 设置批注显示模式为始终显示
运行效果
页面加载后,文本框会自动显示 4 条"评论已更改"记录,分别对应 text、backColor、foreColor、displayMode 四个属性的变化
每条记录显示发生变化的属性英文名称
用户可以手动编辑批注文本、调整批注大小或拖动批注位置,新的变化也会触发事件并记录到文本框中
API 参考
绑定批注事件
事件参数 args 包含:
propertyName - 发生变化的属性名称
comment - 触发事件的批注对象
sheet - 触发事件的工作表
sheetName - 工作表名称
批注管理方法
批注属性方法
显示模式枚举值:GC.Spread.Sheets.Comments.DisplayMode.alwaysShown(始终显示)、hoverShown(悬停显示)等。
window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
initSpread(spread);
};
function initSpread(spread) {
var spreadNS = GC.Spread.Sheets;
var sheet = spread.getSheet(0);
var sheet = spread.getActiveSheet();
sheet.comments.add(1, 1, "新评论!");
sheet.setText(1, 1, "评论");
var commentEvent = document.getElementById("commentEvent");
sheet.bind(spreadNS.Events.CommentChanged, function (e, args) {
var text = commentEvent.value;
if (text !== "") {
text += '\n';
}
commentEvent.value = text + "评论已更改: " + " " + args.propertyName;
});
// get comment and change some properties to fire event
var comment = sheet.comments.get(1, 1);
comment.text("编辑评论、调整大小、拖动或执行其他操作以触发评论更改事件。");
comment.backColor("white");
comment.foreColor("#82BC00");
comment.displayMode(spreadNS.Comments.DisplayMode.alwaysShown);
};
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta name="spreadjs culture" content="zh-cn" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css"
href="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/dist/gc.spread.sheets.all.min.js"
type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-resources-zh/dist/gc.spread.sheets.resources.zh.min.js"
type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script>
<script src="app.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="styles.css">
</head>
<body>
<div class="sample-tutorial">
<div id="ss" class="sample-spreadsheets"></div>
<div class="options-container">
<textarea id="commentEvent" style="width: 100%; height: 90px"></textarea>
</div>
</div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: hidden;
float: left;
}
.options-container {
float: right;
width: 280px;
overflow: auto;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
}
textarea {
width: 100%;
height: 80px;
padding: 6px 12px;
box-sizing: border-box;
}
.sample-options {
z-index: 1000;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}