| Sheets |
גליון עבודה אוסף. See TXLSXSheets |
| Fonts |
Workbook-level גופן palette. Cells pick a גופן by
setting TXLSXCell.FontIndex to a 1-based אינדקס into this
אוסף. See TXLSXFont / TXLSXFonts |
| Fills |
Workbook-level fill palette. Cells pick a fill by
setting TXLSXCell.FillIndex to a 1-based אינדקס into this
אוסף. See TXLSXFill / TXLSXFills |
| Borders |
Workbook-level border palette. Cells pick a border
by setting TXLSXCell.BorderIndex to a 1-based אינדקס into
this אוסף. See TXLSXBorder / TXLSXBorders |
| NumberFormats |
Workbook-level custom number-format palette. Cells
pick a format by setting TXLSXCell.NumberFormatIndex to
a 1-based אינדקס into this אוסף. See
TXLSXNumberFormat / TXLSXNumberFormats |
| DefinedNames |
Workbook-level named ranges (חוברת עבודה-scoped or
sheet-scoped). See
TXLSXDefinedName / TXLSXDefinedNames |
| Calculate |
Compiles and evaluates an Excel formula string against the active sheet, and a leading = is accepted
Cell references, ranges, formulas stored in referenced cells, cross-sheet references, defined-name ranges, and supported text, date, workday, engineering/base-conversion, bitwise, statistical, aggregate, and math functions are evaluated through the shared HotXLS formula engine
See OnUserFunction to handle custom or unsupported functions |
| OnUserFunction, OnUserFunctionEx |
Callback used by Calculate when a
formula calls a custom or unsupported function. See
OnUserFunction / OnUserFunctionEx callback |
| GetSheetNames(FileName, AList), GetSheetNames(Stream, AList) |
Reads xl/חוברת עבודה.xml and appends
גיליון names to AList in חוברת עבודה order without
loading גיליון XML. The זרם overload expects a complete XLSX
package זרם. מחזיר the number of names read, or
-1 when the package cannot be opened |
| Alignments |
Workbook-level תא-alignment palette. Cells pick
an entry by setting TXLSXCell.AlignmentIndex to a
1-based אינדקס into this אוסף. See
TXLSXAlignment |
| Document properties |
Title, Author, Subject, Keywords, Description,
Category, LastModifiedBy, Company, Application, AppVersion,
Created, Modified. Setting any one of them populates
docProps/core.xml + docProps/app.xml on
SaveAs (otherwise the חוברת עבודה keeps the minimal part set) |
| ProtectWorkbook / UnProtectWorkbook |
Workbook protection toggle with an optional
16-bit legacy סיסמה hash and LockStructure /
LockWindows flags. Reflected as
<workbookProtection> in xl/חוברת עבודה.xml |
| LoadVbaProjectFromFile / VbaProject / HasVbaProject / VbaProjectDefined |
LoadVbaProjectFromFile imports a raw vbaProject.bin payload; VbaProject exposes the bytes; HasVbaProject and read-only VbaProjectDefined both report whether a payload is present. Save with a .xlsm extension when macros should be enabled by Excel |
| ParsedVBAProject |
Read-only parsed view of the current
vbaProject.bin payload. When the payload is a valid OLE
VBA storage, returns a TXLSVBAProject exposing module
names and source text; otherwise returns nil. The raw
VbaProject payload remains the authoritative bytes used
for SaveAs/Open round-trip |
| AddChartSheet(Name, Type, Title) |
יוצר a גיליון flagged
IsChartSheet = True and seeds Charts[0]
with a sensible ברירת מחדל full-page anchor. SaveAs writes such sheets
to xl/chartsheets/sheetN.xml. See
TXLSXChart |
| StreamingWrite |
כאשר True, SaveAs uses
WriteWorksheetXmlStreaming per sheet — no sheetXmls
cache is held, sharedStrings.xml is emitted last after every sheet
has populated the SST. Combined with the per-שורה
TXLSWideStringBuilder this keeps memory linear on
large sheets. Default is False (existing behavior) |
| SaveAsEncrypted / OpenEncrypted / CanReadEncrypted |
ECMA-376 Standard Encryption write support
SaveAsEncrypted writes a standard-conforming AES-128
protected OLE Compound File container for non-empty passwords, using
AES-NI acceleration when available and a portable software fallback
otherwise. The encrypted output opens in Excel 2007 and later with
the סיסמה used to save it. CanReadEncrypted detects
the OLE2 magic bytes; OpenEncrypted transparently falls
back to plain Open for unencrypted files and still raises
EXlsxEncryptionNotImplemented for encrypted packages
until decrypt support lands |
| SaveAs(FileName) |
Writes the חוברת עבודה to the given קובץ. מחזיר
1 on success, negative on failure. If the חוברת עבודה has no
sheets a ברירת מחדל Sheet1 is added before writing |
| SaveAs(FileName, FileFormat) |
Accepts xlsxOpenXMLWorkbook for OOXML output or xlsxOpenDocumentSpreadsheet for a direct OpenDocument Spreadsheet (.ods) package. SaveAsODS is the named shortcut for the ODS path and offers the same קובץ-format output plus optional TODSExportOptions control |
| SaveAs(Stream) / SaveAs(Stream, FileFormat) |
Writes the חוברת עבודה directly into any TStream. The FileFormat overload accepts xlsxOpenXMLWorkbook or xlsxOpenDocumentSpreadsheet, making it suitable for in-memory XLSX or ODS generation and BLOB storage paths. מחזיר 1 on success |
| Open(FileName) |
Reads an OOXMLxlsx archive and replaces the
Sheets אוסף with its contents. מחזיר 1
on success |
| Open(FileName, Password) |
Reserved for future encrypted XLSX support. Behaves
like Open(FileName) today — the סיסמה is ignored |
| Open(Stream) |
Reads an OOXMLxlsx archive from a
TStream. מחזיר 1 on success |
| OpenCSV(FileName) / OpenCSV(Stream) |
Imports CSV or TSV text into the חוברת עבודה with
automatic separator detection (,, ;,
tab, or pipe), BOM-based UTF-8 / UTF-16 encoding detection, RFC
4180-style quoted fields, and optional ערך type inference through
the ADetectTypes overloads. Calling
Open(FileName) on .csv or
.tsv routes to this importer automatically. See
OpenCSV method |
| OpenODS(FileName) / OpenODS(Stream) |
Imports an OpenDocument Spreadsheet (.ods) package from a קובץ or זרם. The reader loads content.xml, shared style information from styles.xml, and view settings when present, preserving sheet names, scalar values, cached formula results, basic formula reference conversion, repeated rows/columns/cells, merged ranges, rich text, hyperlinks, comments, embedded images, embedded charts, hidden rows/columns/sheets, שורה heights, עמודה widths, inherited/ברירת מחדל styles, number/date/time/currency/scientific/fraction formats, תא and sheet protection state, named ranges, print areas, manual page breaks, freeze panes, AutoFilter ranges, שורה/עמודה outline groups, headers/footers, data validations including prompts, conditional formats including formulas/color scales/data bars, and sheet tab colour. Full OpenFormula semantics, ODS protection keys, הערה geometry, advanced הערה formatting, and package features outside spreadsheet content are not converted |
| SaveAsODS(FileName) / SaveAsODS(Stream) |
Saves the חוברת עבודה as a valid OpenDocument Spreadsheet package. It writes the ODF mimetype, manifest, metadata, styles, and גיליון content directly, carrying typed values, formulas, styles, rich text, dimensions, merges, hyperlinks, images, charts, named ranges, AutoFilter ranges, conditional formats, data validations, freeze panes, page setup, headers/footers, print ranges, manual page breaks, outline groups, tab colour, and sheet visibility where those features are represented in the HotXLS חוברת עבודה model |
| TODSExportOptions |
Controls ODS export. Generator overrides the meta:generator ערך in meta.xml; an empty ערך uses the built-in HotXLS generator string. IncludeCharts and IncludeImages ברירת מחדל to True and, when False, remove the matching drawing frames, package parts, and manifest entries together so the output has no orphan chart or תמונה references. The caller owns the options instance and must free it |
| GetODSSheetNames(FileName, AList), GetODSSheetNames(Stream, AList) |
Reads only ODS table names from content.xml into AList without resetting or populating the חוברת עבודה. Use it when a קובץ picker or import workflow needs sheet names before loading the חוברת עבודה |
| SaveAsCSV overloads |
Four overloads (FileName or Stream ×
active-sheet ברירת מחדל / explicit SheetIndex + Delimiter). Writes the
chosen sheet as a UTF-8 CSV with BOM. Date values render as
yyyy-mm-dd hh:nn:ss; formula cells are calculated before
export, and formula text is used only when calculation is unavailable
מחזיר 0 on success |
| SaveAsHTML overloads |
Options overloads accept TXLSXHtmlExportOptions for Title, WriteDocument, IncludeStyles, IncludeBOM, and TableClass. Set WriteDocument to False for a table fragment; set IncludeBOM to False when embedding output in an existing UTF-8 response. Exported output now preserves תא hyperlinks as <a> anchors and anchored images as inline data: תמונה URIs; חוברת עבודה-level export includes anchors outside populated cells. Cell comments are also emitted as escaped <td> title attributes, and חוברת עבודה-level export includes הערה-only anchors. When IncludeStyles is enabled, explicit ColWidth values are emitted as <col> widths and explicit RowHeight values as <tr> height styles. Rich-text תא runs are emitted as escaped <span> elements with inline גופן, color, emphasis, and underline styles when IncludeStyles is enabled. Cell borders are emitted as CSS border-left, border-right, border-top, and border-bottom rules when IncludeStyles is enabled. Hidden rows and columns marked by RowHidden / ColHidden, plus explicit zero-width columns, are skipped in the generated table and <colgroup>. Vertical alignment settings are emitted as CSS vertical-align rules when IncludeStyles is enabled |
| SaveAsRTF overloads |
Four overloads (FileName or Stream ×
active-sheet ברירת מחדל / explicit SheetIndex). Writes the chosen sheet
as an RTF 1.6 document with a plain table. Column widths are derived
from ColWidth data (1 char unit ≈ 96 twips;
ברירת מחדל 809 twips). Per-תא bold / italic / גופן size are applied;
non-ASCII characters are encoded as signed-16-bit \uN?
RTF unicode escapes. Merged cells are not spanned. מחזיר 0 on
success |
| ActiveSheet |
1-based אינדקס of the active (selected) sheet (0 when none), matching the classic XLS engine's ActiveSheetIndex. SaveAs writes activeTab="N" on <workbookView> (the OOXML activeTab attribute itself stays 0-based) when חוברת עבודה view options need to be emitted, and marks the matching sheet with tabSelected="1" |
| Minimized / WindowHidden / ShowHorizontalScroll / ShowVerticalScroll |
Workbook-window chrome flags written to <workbookView>. Minimized writes minimized="1", WindowHidden writes visibility="hidden", and ShowHorizontalScroll / ShowVerticalScroll hide or show the חוברת עבודה scrollbars. Open round-trips all four values |
| XWindow / YWindow / WindowWidth / WindowHeight |
Workbook-window geometry written to <workbookView>. XWindow and YWindow store the window origin, while WindowWidth and WindowHeight store its size. Values are clamped to 0..65535 and round-trip on load |
| ShowSheetTabs / TabRatio / FirstSheet / AutoFilterDateGrouping |
Workbook-window view options written to <workbookView>. ShowSheetTabs hides or shows the sheet-tab bar, TabRatio controls the tab-bar-to-scrollbar width split and clamps to 0..1000, FirstSheet selects the first visible tab as a 0-based sheet אינדקס and clamps to an existing sheet, and AutoFilterDateGrouping controls Excel date grouping in AutoFilter dropdowns. Open round-trips all four values |
| Date1904 |
Workbook date base. False (ברירת מחדל) =
Windows 1900 epoch; True = Mac 1904 epoch (shifts every
date serial by 1462 days). Set this before assigning
TDateTime תא values so Excel renders the same
calendar date |
| SourceFormat |
Reports the package family loaded by the most recent successful Open or OpenODS call. It returns xlsxOpenXMLWorkbook for XLSX and xlsxOpenDocumentSpreadsheet for ODS; a newly created חוברת עבודה reports xlsxOpenXMLWorkbook until a קובץ is opened |
| IndexedColor[Index] |
ARGB ערך for the given OOXML indexed-color palette
slot (0..63). Reading returns the user override if set, otherwise the
built-in OOXML ברירת מחדל (XlsxDefaultIndexedPalette)
Writing overrides slot N; SaveAs then emits a full
<indexedColors> block with all 64 slots |
| HasCustomIndexedColor / CustomIndexedColorCount / ResetIndexedColors |
HasCustomIndexedColor(N) returns
True when slot N was explicitly overridden
CustomIndexedColorCount returns the number of overridden
slots (0 = no <colors> block emitted by SaveAs)
ResetIndexedColors discards every override and restores
the ברירת מחדל palette |
| ExternalLinks |
Collection of external חוברת עבודה references. Each
TXLSXExternalLink
entry holds a Target URL and a SheetNames list. SaveAs
emits the <externalReferences> block in
xl/חוברת עבודה.xml and the corresponding
xl/externalLinks/ parts. Open round-trips the Target and
SheetNames; cached תא values inside
<sheetDataSet> are not preserved |