SetComment

设置表格的批注（摘要替代文本）。

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

语法

expression.SetComment(sComment);

expression - 表示 ApiListObject 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
sComment	必需	string		批注字符串。

返回值

此方法不返回任何数据。

示例

为电子表格中的表格对象分配描述性注释。

// How do I add a summary comment to a table in a spreadsheet?

// Document the purpose of a table with a short description stored alongside it in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Product");
worksheet.GetRange("B1").SetValue("Price");
worksheet.GetRange("A2").SetValue("Apples");
worksheet.GetRange("B2").SetValue(100);
worksheet.GetRange("A3").SetValue("Oranges");
worksheet.GetRange("B3").SetValue(150);
let table = worksheet.AddListObject("xlSrcRange", "A1:B3");
table.SetComment("Sales data table");

worksheet.GetRange("D1").SetValue("Comment:");
worksheet.GetRange("E1").SetValue(table.GetComment());