[]
        
首页
开发者学堂
文档
论坛
市场
生态机会
活动
立即试用
(Showing Draft Content)

GC.Spread.Sheets.CustomDocPropsManager

Class: CustomDocPropsManager

Spread.Sheets.CustomDocPropsManager

Table of contents

Constructors

Methods

Constructors

constructor

• new CustomDocPropsManager(workbook)

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

Parameters

Name Type Description
workbook Workbook 工作簿。

Methods

add

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

设置自定义文档属性。

example

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

Parameters

Name Type Description
propName string 属性名称。
value CustomDocumentPropertyValueType 属性值。
isLinkTarget? boolean 是否为内容链接。

Returns

void


all

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

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

example

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

Parameters

Name Type Description
props? ICustomDocumentProperty[] 自定义文档属性。

Returns

undefined | ICustomDocumentProperty[]

自定义文档属性。


clear

▸ clear(): void

清除自定义文档属性。

example

spread.docProps.customDocPropsManager.clear();

Returns

void


get

▸ get(propName): undefined | ICustomDocumentProperty

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

example

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

Parameters

Name Type Description
propName string 属性名称。

Returns

undefined | ICustomDocumentProperty

自定义文档属性。


remove

▸ remove(propName): void

通过属性名称移除自定义文档属性。

example

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

Parameters

Name Type Description
propName string 属性名称。

Returns

void