Name
xlsx.GetCellFormula -- get cell formula
Synopsis
f$ = xlsx.GetCellFormula(id, x, y[, sheet])
f$ = xlsx.GetCellFormula(id, ref[, sheet])
Function
This function returns the formula of a certain cell. There are two ways of specifying the cell whose formula should be returned: You can either specify the cell to use by passing the cell's column (x) and row (y) position in the x and y arguments. Those positions start from 1 for the first column and row. Alternatively, you can also specify the cell by passing its reference in the ref parameter. This can either be a string, e.g. "A10" for the first cell in the 10th row, or an iterator state returned by the xlsx.CellRange() function. Optionally, you can also pass the index of the worksheet to use in the optional sheet parameter (starting from 1 for the first worksheet). If the sheet parameter is omitted, the worksheet set by xlsx.SetDefaultSheet() will be used.

Note that this function will fail in case the cell doesn't have a formula. You can use xlsx.HaveCellFormula() to check if the cell has got a formula.

Inputs
id
identifier of the XLSX document to use
x
column index of the cell to use (starting from 1)
y
row index of the cell to use (starting from 1)
ref
cell reference (e.g. "A1" or an iterator state), only used when x and y are omitted
sheet
optional: index of the worksheet to use (defaults to the index of the default worksheet)
Results
f$
the cell's formula

Show TOC