wb.properties

WorkbookProperties

WorkbookProperties -- Document properties sub-API interface. Provides methods to read and write document metadata (title, author, keywords, etc.) and custom document properties.

6 methods

getDocumentProperties

→ Promise<DocumentProperties>

getDocumentProperties(): Promise<DocumentProperties>;

Get all document properties (author, title, keywords, etc.).

DocumentProperties

setDocumentProperties

→ Promise<void>

setDocumentProperties(props: Partial<DocumentProperties>): Promise<void>;

Parameter	Type	Required
props	Partial<DocumentProperties>	required

Update document properties (partial merge).

DocumentProperties

getCustomProperty

→ Promise<string | undefined>

getCustomProperty(key: string): Promise<string | undefined>;

Parameter	Type	Required
key	string	required

Get a custom document property by key.

setCustomProperty

→ Promise<void>

setCustomProperty(key: string, value: string): Promise<void>;

Parameter	Type	Required
key	string	required
value	string	required

Set a custom document property.

removeCustomProperty

→ Promise<void>

removeCustomProperty(key: string): Promise<void>;

Parameter	Type	Required
key	string	required

Remove a custom document property.

listCustomProperties

→ Promise<Array<{ key: string; value: string }>>

listCustomProperties(): Promise<Array<{ key: string; value: string }>>;

List all custom document properties.