Skip to content

XLSX File

Reference


Reads and writes data from a XLS/XLSX file.

Categories: [helpers]

Version: 1


Actions

Read from file

Reads data from a XLS/XLSX file.

Properties

NameTypeControl TypeDescription
FileFILE_ENTRYFILE_ENTRYThe object property which contains a reference to the XLS/XLSX file to read from.
Sheet NameSTRINGTEXTThe name of the sheet to read from in the spreadsheet. If not set, the first one gets chosen.
Header RowBOOLEANSELECTThe first row of the file contains the header names.
Include Empty CellsBOOLEANSELECTWhen reading from file the empty cells will be filled with an empty string.
Page SizeINTEGERINTEGERThe amount of child elements to return in a page.
Page NumberINTEGERINTEGERThe page number to get.
Read As StringBOOLEANSELECTIn some cases and file formats, it is necessary to read data specifically as string, otherwise some special characters are interpreted the wrong way.

Write to file

Writes the data to a XLS/XLSX file.

Properties

NameTypeControl TypeDescription
Sheet NameSTRINGTEXTThe name of the sheet to create in the spreadsheet.
Rows[{}]ARRAY_BUILDERThe array of objects to write to the file.
FilenameSTRINGTEXTFilename to set for binary data. By default, “file.xlsx” will be used.

Output

Type: FILE_ENTRY

Properties

TypeControl Type
STRINGTEXT
STRINGTEXT
STRINGTEXT
STRINGTEXT