类: CustomDocPropsManager

Spread.Sheets.CustomDocPropsManager

Table of contents

构造方法

• constructor

方法

• add
• all
• clear
• get
• remove

构造方法

constructor

• new CustomDocPropsManager(workbook)

代表自定义文档属性管理器。它可以管理所有文档的自定义属性。

参数

方法

add

▸ add(propName, value, isLinkTarget?): void

设置自定义文档属性。

代码示例

spread.docProps.customDocPropsManager.add('prop1', '1');
spread.docProps.customDocPropsManager.add('prop2', 'CellAlias', true);

参数

返回值

void

all

▸ all(props?): undefined | ICustomDocumentProperty[]

获取或设置自定义文档属性。

代码示例

spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.all();

参数

返回值

undefined | ICustomDocumentProperty[]

自定义文档属性。

clear

▸ clear(): void

清除自定义文档属性。

代码示例

spread.docProps.customDocPropsManager.clear();

返回值

void

get

▸ get(propName): undefined | ICustomDocumentProperty

通过属性名称获取自定义文档属性。

代码示例

spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.get('prop1');

参数

返回值

undefined | ICustomDocumentProperty

自定义文档属性。

remove

▸ remove(propName): void

按属性名称删除自定义文档属性。

代码示例

spread.docProps.customDocPropsManager.remove('prop1');

参数

返回值

void