WorkbookMetadata
Contents
[
Hide
]WorkbookMetadata class
Represents the meta data.
class WorkbookMetadata;
Constructors
| Name | Description |
|---|---|
| constructor(string, MetadataOptions) | Create the meta data object. |
| constructor(Uint8Array, MetadataOptions) | Create the meta data object. |
Properties
| Property | Type | Description |
|---|---|---|
| options | MetadataOptions | Readonly. Gets the options of the metadata. |
| builtInDocumentProperties | BuiltInDocumentPropertyCollection | Readonly. Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet. |
| customDocumentProperties | CustomDocumentPropertyCollection | Readonly. Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet. |
Methods
| Method | Description |
|---|---|
| save(string) | Save the modified metadata to the file. |
| save(Uint8Array) | Save the modified metadata to the stream. |
constructor(string, MetadataOptions)
Create the meta data object.
constructor(fileName: string, options: MetadataOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileName | string | |
| options | MetadataOptions |
constructor(Uint8Array, MetadataOptions)
Create the meta data object.
constructor(stream: Uint8Array, options: MetadataOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | Uint8Array | |
| options | MetadataOptions |
options
Readonly. Gets the options of the metadata.
options : MetadataOptions;
builtInDocumentProperties
Readonly. Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
builtInDocumentProperties : BuiltInDocumentPropertyCollection;
customDocumentProperties
Readonly. Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
customDocumentProperties : CustomDocumentPropertyCollection;
save(string)
Save the modified metadata to the file.
save(fileName: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileName | string | The file name. |
save(Uint8Array)
Save the modified metadata to the stream.
save(stream: Uint8Array) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | Uint8Array | The stream. |