SetDescription

设置文档描述。

语法

expression.SetDescription(sDescription);

expression - 表示 ApiCore 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
sDescription	必需	string		文档描述。

返回值

此方法不返回任何数据。

示例

此示例演示如何使用 ApiCore 设置当前工作簿的描述。

const worksheet = Api.GetActiveSheet();
const core = Api.GetCore();

core.SetDescription("This is a sample workbook made to help fellow users understand how to use the ApiCore methods.");
const description = core.GetDescription();

let fill = Api.CreateSolidFill(Api.RGB(100, 50, 200));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = worksheet.AddShape(
	"rect",
	100 * 36000, 100 * 36000,
	fill, stroke,
	0, 0, 3, 0
);

let paragraph = shape.GetContent().GetElement(0);
paragraph.AddText("Description: " + description);