跳到主要内容

GetDescription

返回文档描述。

语法​

expression.GetDescription();

expression - 表示 ApiCore 类的变量。

参数​

此方法没有任何参数。

返回值​

string

示例​

读取电子表格工作簿属性中存储的描述。

// How do I retrieve the text description of a workbook in a spreadsheet?

// Extract and display the summary text saved with the workbook in a spreadsheet.

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);