[]
Spread.Sheets.CustomDocPropsManager
• new CustomDocPropsManager(workbook)
表示自定义文档属性管理器。它可以管理所有文档的自定义属性。
| Name | Type | Description |
|---|---|---|
workbook |
Workbook |
工作簿。 |
▸ add(propName, value, isLinkTarget?): void
设置自定义文档属性。
example
spread.docProps.customDocPropsManager.add('prop1', '1');
spread.docProps.customDocPropsManager.add('prop2', 'CellAlias', true);
| Name | Type | Description |
|---|---|---|
propName |
string |
属性名称。 |
value |
CustomDocumentPropertyValueType |
属性值。 |
isLinkTarget? |
boolean |
是否为内容链接。 |
void
▸ all(props?): undefined | ICustomDocumentProperty[]
获取或设置自定义文档属性。
example
spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.all();
| Name | Type | Description |
|---|---|---|
props? |
ICustomDocumentProperty[] |
自定义文档属性。 |
undefined | ICustomDocumentProperty[]
自定义文档属性。
▸ clear(): void
清除自定义文档属性。
example
spread.docProps.customDocPropsManager.clear();
void
▸ get(propName): undefined | ICustomDocumentProperty
通过属性名称获取自定义文档属性。
example
spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.get('prop1');
| Name | Type | Description |
|---|---|---|
propName |
string |
属性名称。 |
undefined | ICustomDocumentProperty
自定义文档属性。
▸ remove(propName): void
通过属性名称移除自定义文档属性。
example
spread.docProps.customDocPropsManager.remove('prop1');
| Name | Type | Description |
|---|---|---|
propName |
string |
属性名称。 |
void