WorkbookMetadata

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.

Methods

Method	Description
getOptions()	Gets the options of the metadata.
getBuiltInDocumentProperties()	Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
getCustomDocumentProperties()	Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
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

getOptions()

Gets the options of the metadata.

getOptions() : MetadataOptions;

Returns

MetadataOptions

getBuiltInDocumentProperties()

Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.

getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection;

Returns

BuiltInDocumentPropertyCollection

getCustomDocumentProperties()

Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.

getCustomDocumentProperties() : CustomDocumentPropertyCollection;

Returns

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.