GetDescription

返回文档描述。

语法

expression.GetDescription();

expression - 表示 ApiCore 类的变量。

参数

此方法没有任何参数。

返回值

string

示例

读取文档核心属性中存储的描述。

// How do I retrieve the description text from the core properties in a document?

// Display a document's summary text to give readers context about its contents 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);