跳到主要内容

SetDescription

设置文档描述。

语法

expression.SetDescription(sDescription);

expression - 表示 ApiCore 类的变量。

参数

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

返回值

此方法不返回任何数据。

示例

使用文档中的核心属性设置当前文档的描述。

// How do I set description in a document?

// Set description using a core properties object in a document.

const doc = Api.GetDocument();
const core = doc.GetCore();
core.SetDescription("This is a sample document made to help fellow users understand how to use the ApiCore methods.");

const description = core.GetDescription();
let paragraph = doc.GetElement(0);
paragraph.AddText("Description: " + description);