sheetjs-clone/docbits/57_wbbook.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

### Workbook-Level Attributes
`wb.Workbook` stores workbook-level attributes.
#### Defined Names
2022-05-09 06:49:17 +00:00
<details>
<summary><b>Format Support</b> (click to show)</summary>
**Defined Names**: XLSX/M, XLSB, BIFF8 XLS, XLML, SYLK
**Unicode Defined Names**: XLSX/M, XLSB, BIFF8 XLS, XLML
**Defined Name Comment**: XLSX/M, XLSB, BIFF8 XLS
</details>
`wb.Workbook.Names` is an array of defined name objects which have the keys:
<details>
2017-09-24 23:40:09 +00:00
<summary><b>Defined Name Properties</b> (click to show)</summary>
| Key | Description |
|:----------|:-----------------------------------------------------------------|
| `Sheet` | Name scope. Sheet Index (0 = first sheet) or `null` (Workbook) |
| `Name` | Case-sensitive name. Standard rules apply ** |
2017-09-24 23:40:09 +00:00
| `Ref` | A1-style Reference (`"Sheet1!$A$1:$D$20"`) |
| `Comment` | Comment (only applicable for XLS/XLSX/XLSB) |
</details>
Excel allows two sheet-scoped defined names to share the same name. However, a
sheet-scoped name cannot collide with a workbook-scope name. Workbook writers
may not enforce this constraint.
#### Workbook Views
`wb.Workbook.Views` is an array of workbook view objects which have the keys:
| Key | Description |
|:----------------|:----------------------------------------------------|
| `RTL` | If true, display right-to-left |
#### Miscellaneous Workbook Properties
`wb.Workbook.WBProps` holds other workbook properties:
2017-06-03 07:19:09 +00:00
| Key | Description |
|:----------------|:----------------------------------------------------|
| `CodeName` | [VBA Project Workbook Code Name](#vba-and-macros) |
2017-06-03 07:19:09 +00:00
| `date1904` | epoch: 0/false for 1900 system, 1/true for 1904 |
| `filterPrivacy` | Warn or strip personally identifying info on save |