Skip to main content

Module workbook

Module workbook 

Source
Expand description

Workbooks.

Structs§

ActiveSheet
The active sheet index of a Workbook.
CalcSettings
File › Options › Formulas › Calculation options, stored per workbook (<calcPr>).
DefinedName
DocProps
PhoneticProps
The <phoneticPr> of a string item: how its phonetic runs are displayed. kind (type) and alignment only ever hold values ISO/IEC 29500-1 §18.18.57 ST_PhoneticType / §18.18.56 ST_PhoneticAlignment define, so damaged files cannot be written back invalid.
PhoneticRun
One phonetic (furigana) run of a string item (<rPh>): the reading text and the range of the base text it annotates.
PhoneticString
The phonetic (furigana) data of one shared string: its <rPh> runs, in document order, and its <phoneticPr> when the file had one.
Workbook
WorkbookView
The workbook window’s display settings from <workbookView> (Excel: File › Options › Advanced, “Display options for this workbook”): whether the window shows the sheet tabs and the two scroll bars, and how much of the horizontal bar the tabs take (tabRatio, thousandths of the bar; the format’s default is 600). XLSX I/O normalizes this share to 0–1000, including values supplied directly through the model.

Enums§

CalcMode
ShowObjects
Options › Advanced › “For objects, show” (<workbookPr showObjects>, ECMA-376 ST_Objects): whether charts, pictures, shapes and slicers are drawn. Ctrl+6 switches between All and None; Placeholders only comes from files and is kept as it is.

Constants§

EQUATION_BUDGET_MESSAGE
Why an equation past MAX_EQUATION_LAYOUT_BYTES has no layout.
MAX_EQUATION_LAYOUT_BYTES
Most equation source, in bytes, one Workbook::refresh_equations lays out: about 2,500 typical equations, or a few seconds of the slowest 4 KB sources.