## WorkbookMetadata class

Represents the meta data.

```javascript
class WorkbookMetadata;
```


## Constructors

| Constructor | Description |
| --- | --- |
| [constructor(string, MetadataOptions)](#constructor-string-metadataoptions-)| Create the meta data object. |
| [constructor(Uint8Array, MetadataOptions)](#constructor-uint8array-metadataoptions-)| Create the meta data object. |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [options](#options--)| MetadataOptions | Readonly. Gets the options of the metadata. |
| [builtInDocumentProperties](#builtInDocumentProperties--)| BuiltInDocumentPropertyCollection | Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the  built-in document properties of the spreadsheet. |
| [customDocumentProperties](#customDocumentProperties--)| CustomDocumentPropertyCollection | Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet. |

## Methods

| Method | Description |
| --- | --- |
| [getOptions()](#getOptions--)| <b>@deprecated.</b> Please use the 'options' property instead. Gets the options of the metadata. |
| [getBuiltInDocumentProperties()](#getBuiltInDocumentProperties--)| <b>@deprecated.</b> Please use the 'builtInDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the  built-in document properties of the spreadsheet. |
| [getCustomDocumentProperties()](#getCustomDocumentProperties--)| <b>@deprecated.</b> Please use the 'customDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet. |
| [save(string)](#save-string-)| Save the modified metadata to the file. |
| [save(Uint8Array)](#save-uint8array-)| Save the modified metadata to the stream. |
| [isNull()](#isNull--)| Checks whether the implementation object is null. |


### constructor(string, MetadataOptions) {#constructor-string-metadataoptions-}

Create the meta data object.

```javascript
constructor(fileName: string, options: MetadataOptions);
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | string |  |
| options | [MetadataOptions](../metadataoptions/) |  |

### constructor(Uint8Array, MetadataOptions) {#constructor-uint8array-metadataoptions-}

Create the meta data object.

```javascript
constructor(stream: Uint8Array, options: MetadataOptions);
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array |  |
| options | [MetadataOptions](../metadataoptions/) |  |

### options {#options--}

Readonly. Gets the options of the metadata.

```javascript
options : MetadataOptions;
```


### builtInDocumentProperties {#builtInDocumentProperties--}

Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the  built-in document properties of the spreadsheet.

```javascript
builtInDocumentProperties : BuiltInDocumentPropertyCollection;
```


### customDocumentProperties {#customDocumentProperties--}

Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet.

```javascript
customDocumentProperties : CustomDocumentPropertyCollection;
```


### getOptions() {#getOptions--}

<b>@deprecated.</b> Please use the 'options' property instead. Gets the options of the metadata.

```javascript
getOptions() : MetadataOptions;
```


**Returns**

[MetadataOptions](../metadataoptions/)

### getBuiltInDocumentProperties() {#getBuiltInDocumentProperties--}

<b>@deprecated.</b> Please use the 'builtInDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the  built-in document properties of the spreadsheet.

```javascript
getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection;
```


**Returns**

[BuiltInDocumentPropertyCollection](../builtindocumentpropertycollection/)

### getCustomDocumentProperties() {#getCustomDocumentProperties--}

<b>@deprecated.</b> Please use the 'customDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet.

```javascript
getCustomDocumentProperties() : CustomDocumentPropertyCollection;
```


**Returns**

[CustomDocumentPropertyCollection](../customdocumentpropertycollection/)

### save(string) {#save-string-}

Save the modified metadata to the file.

```javascript
save(fileName: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | string | The file name. |

### save(Uint8Array) {#save-uint8array-}

Save the modified metadata to the stream.

```javascript
save(stream: Uint8Array) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array | The stream. |

### isNull() {#isNull--}

Checks whether the implementation object is null.

```javascript
isNull() : boolean;
```