- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Excel.IO
GC.Spread.Sheets.Comments.Comment
类: Comment
Table of contents
构造方法
方法
- autoSize
- backColor
- borderColor
- borderStyle
- borderWidth
- commentState
- displayMode
- dynamicMove
- dynamicSize
- fontFamily
- fontSize
- fontStyle
- fontWeight
- foreColor
- height
- horizontalAlign
- indicatorColor
- indicatorSize
- location
- lockText
- locked
- opacity
- padding
- showShadow
- text
- textDecoration
- width
- zIndex
构造方法
constructor
• new Comment(text?)
批注
代码示例
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);
comment.autoSize(true);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 |
|---|---|
text? |
string |
方法
autoSize
▸ autoSize(value?): any
获取或设置批注是否根据其内容自动调整大小
代码示例
//本示例使用autoSize方法
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);
comment.autoSize(true);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注是否自动调整大小 |
返回值
any
如果未设置任何值，则返回批注是否自动调整大小。否则，返回批注
backColor
▸ backColor(value?): any
获取或设置批注的背景色
代码示例
//本示例设置backColor方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的背景颜色 |
返回值
any
如果未设置任何值，则返回批注的背景色；否则，返回批注
borderColor
▸ borderColor(value?): any
获取或设置批注的边框颜色
代码示例
//本示例设置borderColor方法
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);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的边框颜色 |
返回值
any
如果未设置任何值，则返回批注的边框颜色；否则，返回批注
borderStyle
▸ borderStyle(value?): any
获取或设置批注的边框样式
代码示例
//本示例设置borderStyle方法
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);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的边框样式 |
返回值
any
如果未设置任何值，则返回批注的边框样式; 否则，返回批注
borderWidth
▸ borderWidth(value?): any
获取或设置批注的边框宽度
代码示例
//本示例设置borderWidth方法
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);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的边框宽度 |
返回值
any
如果未设置任何值，则返回批注的边框宽度；否则，返回批注
commentState
▸ commentState(value?): any
获取或设置批注的状态
代码示例
//本示例使用了批注状态.
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());
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
CommentState |
批注状态 |
返回值
any
如果未设置任何值，则返回批注的状态；否则，返回批注
displayMode
▸ displayMode(value?): any
获取或设置批注的显示模式
代码示例
//本示例设置displayMode方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
DisplayMode |
批注的显示模式 |
返回值
any
如果未设置任何值，则返回批注的显示模式; 否则，返回批注
dynamicMove
▸ dynamicMove(value?): any
获取或设置批注是否动态移动
代码示例
//本示例使用dynamicMove方法
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);
comment.dynamicMove(true);
comment.dynamicSize(true);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注是否动态移动 |
返回值
any
如果未设置任何值，则返回批注是否动态移动；否则，返回批注
dynamicSize
▸ dynamicSize(value?): any
获取或设置批注是否为动态大小
代码示例
//本示例使用dynamicSize方法
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);
comment.dynamicMove(true);
comment.dynamicSize(true);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注是否为动态大小 |
返回值
any
如果未设置任何值，则返回批注是否为动态大小；否则，返回批注
fontFamily
▸ fontFamily(value?): any
获取或设置批注的字体系列
代码示例
//本示例使用fontFamily方法
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);
comment.fontFamily("Comic Sans MS");
comment.fontSize("10pt");
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的字体系列 |
返回值
any
如果未设置任何值，则返回批注的字体系列; 否则，返回批注
fontSize
▸ fontSize(value?): any
Gets or sets the font size for the comment. Valid value is numbers followed by "pt" (required), such as "12pt".
代码示例
//本示例使用fontSize方法
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);
comment.fontFamily("Comic Sans MS");
comment.fontSize("10pt");
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的字体大小 |
返回值
any
如果未设置任何值，则返回批注的字体大小; 否则，返回批注
fontStyle
▸ fontStyle(value?): any
获取或设置批注的字体样式
代码示例
//本示例使用fontStyle方法
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);
comment.fontFamily("Comic Sans MS");
comment.fontStyle("normal");
comment.fontWeight("normal");
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的字体样式 |
返回值
any
如果未设置任何值，则返回批注的字体样式; 否则，返回批注
fontWeight
▸ fontWeight(value?): any
获取或设置批注的字体粗细
代码示例
//本示例使用fontWeight方法
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);
comment.fontFamily("Comic Sans MS");
comment.fontStyle("normal");
comment.fontWeight("normal");
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的字体粗细 |
返回值
any
如果未设置任何值，则返回批注的字体粗细；否则，返回批注
foreColor
▸ foreColor(value?): any
获取或设置批注的文本颜色
代码示例
//本示例设置foreColor方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的文本颜色 |
返回值
any
如果未设置任何值，则返回批注的文本颜色；否则，返回批注
height
▸ height(value?): any
获取或设置批注的高度
代码示例
//本示例设置了height方法
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);
comment.height(50);
comment.width(90);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的高度 |
返回值
any
如果未设置任何值，则返回批注的高度；否则，返回批注
horizontalAlign
▸ horizontalAlign(value?): any
获取或设置批注的水平对齐方式
代码示例
//本示例使用horizontalAlign方法
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);
comment.horizontalAlign(GC.Spread.Sheets.HorizontalAlign.center);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
HorizontalAlign |
批注的水平对齐方式 |
返回值
any
如果未设置任何值，则返回批注的水平对齐方式；否则，返回批注
indicatorColor
▸ indicatorColor(value?): any
获取或设置批注的indicatorColor
代码示例
//本例使用了indicatorColor方法
var comment = new GC.Spread.Sheets.Comments.Comment();
var color1 = "red";
var color2 = "#FFFFFF";
var color2 = "rgba(255, 255, 255, 0.01)";
comment.indicatorColor(color1);
activeSheet.comments.add(5, 5, comment);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注的indicatorColor |
返回值
any
如果没有设置值，返回批注器的颜色；否则，返回批注
indicatorSize
▸ indicatorSize(value?): any
获取或设置批注的indicatorColor
代码示例
//本例使用了indicatorColor方法
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.indicatorSize(6);
activeSheet.comments.add(5, 5, comment);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的indicatorColor |
返回值
any
如果没有设置值，则返回批注器的大小；否则，返回批注
location
▸ location(value?): any
获取或设置批注的位置
代码示例
//本示例使用location方法
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);
comment.location(new GC.Spread.Sheets.Point(10, 10));
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
Point |
批注的位置 |
返回值
any
如果未设置任何值，则返回批注的位置；否则，返回批注
lockText
▸ lockText(value?): any
获取或设置批注的锁定文本
代码示例
//本示例使用lockText方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注的锁定文本 |
返回值
any
如果未设置任何值，则返回批注的锁定文本；否则，返回批注
locked
▸ locked(value?): any
获取或设置批注的锁定设置
代码示例
//本示例使用锁定方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注的锁定设置 |
返回值
any
如果未设置任何值，则返回批注的锁定设置; 否则，返回批注
opacity
▸ opacity(value?): any
获取或设置批注的不透明度
代码示例
//本示例设置不透明度
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);
comment.opacity(10);
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的不透明度 |
返回值
any
如果未设置任何值，则返回批注的不透明度；否则，返回批注
padding
▸ padding(value?): any
获取或设置批注的边距
代码示例
//本示例使用padding方法
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);
comment.padding(new GC.Spread.Sheets.Comments.Padding(2, 2, 2, 2));
activeSheet.getCell(5,5).comment(comment);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
Padding |
批注的边距 |
返回值
any
如果未设置任何值，则返回批注的边距；否则，返回批注
showShadow
▸ showShadow(value?): any
获取或设置批注是否显示阴影
代码示例
//本示例使用showShadow方法
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);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
comment.showShadow(true);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
批注是否显示阴影 |
返回值
any
如果未设置任何值，则返回批注是否显示阴影；否则，返回批注
text
▸ text(value?): any
获取或设置批注文本
代码示例
//本示例设置text方法
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);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
string |
批注文本 |
返回值
any
如果未设置任何值，则返回批注文本；否则，返回批注
textDecoration
▸ textDecoration(value?): any
获取或设置批注的文本修饰
代码示例
//本示例使用textDecoration方法
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);
comment.textDecoration(GC.Spread.Sheets.TextDecorationType.underline);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
TextDecorationType |
批注的文本修饰 |
返回值
any
如果未设置任何值，则返回批注的文本修饰；否则，返回批注
width
▸ width(value?): any
获取或设置批注的宽度
代码示例
//本示例设置width方法
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);
comment.height(50);
comment.width(90);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的宽度 |
返回值
any
如果未设置任何值，则返回批注的宽度；否则，返回批注
zIndex
▸ zIndex(value?): any
获取或设置批注的索引
代码示例
//本示例获取了索引
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.zIndex());
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
number |
批注的索引 |
返回值
any
如果未设置任何值，则返回批注的索引；否则，返回批注