ExcelXMLFile

📊 Overview: 7 Properties

1 Constructor

7 Functions

📝 Description

Converts a 4D selection-based listbox to Excel rows with styled cells matching listbox appearance

🕐 Last updated: 2026-01-13T16:04:11.704Z

---

📑 Table of Contents

• 📋 Properties (7)
• 🏗️ Constructor
• ⚙️ Functions
  • Regular Functions
    • addSelectionBasedListbox (1 param)
    • setFreezePanes (2 params)
    • addColumn (2 params)
    • addRow (1 param)
    • addStyle (1 param) → Text
    • saveToClipboard (2 params)
    • generate

---

Properties

Property	Type	Default	Description
Styles	Collection	[]	Collection of ExcelXMLFileStyle objects for cell formatting
Rows	Collection	[]	Collection of ExcelXMLFileRow objects representing worksheet rows
Columns	Collection	[]	Collection of column width definitions
FileContents	Text	""	Generated XML content for Excel file
FreezeRowsAbove	Integer	0	Number of rows to freeze at top of worksheet
FreezeRowsToLeft	Integer	0	Number of columns to freeze at left of worksheet
ConditionalFormatting	Object	-	Conditional formatting rules for cells

Constructor

constructor

[🏗️ constructor]

Class constructor

Creates a new Excel XML file object with empty collections

---

Functions

Regular Functions

addSelectionBasedListbox

Function addSelectionBasedListbox($ListboxName : Text)

Converts a 4D selection-based listbox to Excel rows with styled cells matching listbox appearance

Parameters:

Name	Type	Optional	Description
$ListboxName	Text	-	-

---

setFreezePanes

Function setFreezePanes($RowsAbove : Integer; $RowsToLeft : Integer)

Sets freeze panes for worksheet; rows above and columns to left will remain visible when scrolling

Parameters:

Name	Type	Optional	Description
$RowsAbove	Integer	-	-
$RowsToLeft	Integer	-	-

---

addColumn

Function addColumn($Width : Real; $Span : Integer)

Adds a column definition to the worksheet with optional width and span; used to define column layout

Parameters:

Name	Type	Optional	Description
$Width	Real	-	-
$Span	Integer	-	-

---

addRow

Function addRow($ExcelXMLFileRow : cs.ExcelXMLFileRow)

Adds a row of cells to the worksheet; stores row object for later generation to Excel XML

Parameters:

Name	Type	Optional	Description
$ExcelXMLFileRow	cs.ExcelXMLFileRow	-	-

---

addStyle

Function addStyle($NewExcelXMLFileStyle : cs.ExcelXMLFileStyle) -> Text

Adds a cell style to the worksheet; deduplicates identical styles and returns unique style ID for cell reference

Parameters:

Name	Type	Optional	Description
$NewExcelXMLFileStyle	cs.ExcelXMLFileStyle	-	-

Returns: Text

---

saveToClipboard

Function saveToClipboard($FileNameWithoutExtension : Text; $ShowAlert : Boolean)

Generates Excel XML, saves to temporary file, copies to clipboard; displays optional alert with instructions

Parameters:

Name	Type	Optional	Description
$FileNameWithoutExtension	Text	-	-
$ShowAlert	Boolean	-	-

---

generate

Function generate

Generates complete Excel XML file content from rows, columns, and styles; creates valid XML Spreadsheet format

---

---

Generated from ExcelXMLFile.4dm