Workbook
Overview
Workbook is a class in Aspose.Cells FOSS for TypeScript.
This class declares 9 methods for Workbook objects in TypeScript programs.
Available methods include: constructor, getNumFmt, load, protect, save, toCsv, toHtml, toJson, toMarkdown.
Public members are accessible to any TypeScript application after installing the Aspose.Cells FOSS for TypeScript package.
Properties: activeTab, borderId, cells, charts, code, col, and 15 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
worksheets | WorksheetCollection | Read | Gets the worksheets. |
sharedStrings | string[] | Read | Gets the shared strings. |
isProtected | boolean | Read | Gets the is protected. |
charts | ChartInfo[] | Read | Gets the charts. |
images | ImageInfo[] | Read | Gets the images. |
activeTab | number | Read/Write | Gets the active tab. |
password | : string | Read | Gets the password. |
saveFormat | : SaveFormat | Read | Gets the save format. |
password | : string | Read | Gets the password. |
saveFormat | : SaveFormat | Read | Gets the save format. |
col | : number | Read | Gets the col. |
colOff | : number | Read | Gets the col off. |
row | : number | Read | Gets the row. |
rowOff | : number | Read | Gets the row off. |
col | : number | Read | Gets the col. |
colOff | : number | Read | Gets the col off. |
row | : number | Read | Gets the row. |
rowOff | : number | Read | Gets the row off. |
id | : number | Read | Gets the id. |
code | : string | Read | Gets the code. |
fontId | : number | Read | Gets the font id. |
fillId | : number | Read | Gets the fill id. |
borderId | : number | Read | Gets the border id. |
numFmtId | : number | Read | Gets the num fmt id. |
style | : Style | Read | Gets the style. |
sheetName | : string | Read | Gets the sheet name. |
cells | : { [key: string]: CellValue } | Read | Gets the cells. |
Methods
| Signature | Description |
|---|---|
constructor(createDefault: boolean) | Calls constructor(createDefault) on this Workbook instance. |
load(filePath: string, password: string) → Promise<Workbook> | Calls load(filePath, password) on this Workbook instance. |
getNumFmt(numFmtId: string | null) → string | Calls getNumFmt(numFmtId) on this Workbook instance. |
protect(protect: boolean, password: string) | Calls protect(protect, password) on this Workbook instance. |
save(filePath: string, options: { password?: string; saveFormat?: SaveFormat }) | Calls save(filePath, options) on this Workbook instance. |
toHtml() → string | Calls toHtml on this Workbook instance. |
toCsv() → string | Calls toCsv on this Workbook instance. |
toJson() → string | Calls toJson on this Workbook instance. |
toMarkdown() → string | Calls toMarkdown on this Workbook instance. |