# GC.Spread.Sheets.CustomDocPropsManager

## Content

# Class: CustomDocPropsManager

[Spread](../modules/GC.Spread).[Sheets](../modules/GC.Spread.Sheets).CustomDocPropsManager

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.CustomDocPropsManager#constructor)

### Methods

- [add](GC.Spread.Sheets.CustomDocPropsManager#add)
- [all](GC.Spread.Sheets.CustomDocPropsManager#all)
- [clear](GC.Spread.Sheets.CustomDocPropsManager#clear)
- [get](GC.Spread.Sheets.CustomDocPropsManager#get)
- [remove](GC.Spread.Sheets.CustomDocPropsManager#remove)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new CustomDocPropsManager**(`workbook`)

Represents a custom document property manager. It can manage custom properties on all documents.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workbook` | [`Workbook`](GC.Spread.Sheets.Workbook) | The workbook. |

## Methods

### <a id="add" name="add"></a> add

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

Set custom document property.

**`example`**
```javascript
spread.docProps.customDocPropsManager.add('prop1', '1');
spread.docProps.customDocPropsManager.add('prop2', 'CellAlias', true);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `propName` | `string` | Property name. |
| `value` | [`CustomDocumentPropertyValueType`](../modules/GC.Spread.Sheets#customdocumentpropertyvaluetype) | Property value. |
| `isLinkTarget?` | `boolean` | Is it a content link. |

#### Returns

`void`

___

### <a id="all" name="all"></a> all

▸ **all**(`props?`): `undefined` \| [`ICustomDocumentProperty`](../interfaces/GC.Spread.Sheets.ICustomDocumentProperty)[]

Get or set custom document properties.

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `props?` | [`ICustomDocumentProperty`](../interfaces/GC.Spread.Sheets.ICustomDocumentProperty)[] | Custom document properties. |

#### Returns

`undefined` \| [`ICustomDocumentProperty`](../interfaces/GC.Spread.Sheets.ICustomDocumentProperty)[]

Custom document properties.

___

### <a id="clear" name="clear"></a> clear

▸ **clear**(): `void`

Clear custom document properties.

**`example`**
```javascript
spread.docProps.customDocPropsManager.clear();
```

#### Returns

`void`

___

### <a id="get" name="get"></a> get

▸ **get**(`propName`): `undefined` \| [`ICustomDocumentProperty`](../interfaces/GC.Spread.Sheets.ICustomDocumentProperty)

Get custom document property by property name.

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `propName` | `string` | Property name. |

#### Returns

`undefined` \| [`ICustomDocumentProperty`](../interfaces/GC.Spread.Sheets.ICustomDocumentProperty)

Custom document property.

___

### <a id="remove" name="remove"></a> remove

▸ **remove**(`propName`): `void`

Remove custom document property by property name.

**`example`**
```javascript
spread.docProps.customDocPropsManager.remove('prop1');
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `propName` | `string` | Property name. |

#### Returns

`void`