Skip to main content
Skip table of contents

modifyWorkbook

This command requires an extra license.

Prepares an XLSX workbook to be modified by this command's child commands. After the child commands have done their jobs, the modified workbook is saved into the variable context.

Child commands

  • setCellValue
    Optional. One or more of these child commands can be used to modify the cell values of the workbook.

  • setDefinedNameValue
    Optional. One or more of these child commands can be used to modify the cell values of the workbook.

  • insertColumnValues
    Optional. One or more of these child commands can be used to modify the cell values of a column in the workbook.

  • insertRowValues
    Optional. One or more of these child commands can be used to modify the cell values of a row on the workbook.

Attributes

var

Required

Value type

EL-evaluated

Yes

String

No

Defines the name of the variable that will hold the modified workbook File.

workbook

Required

Value type

EL-evaluated

Yes

File

Yes

Defines the XLSX workbook that is to be modified. The resolved File is therefore expected to be an XLSX document.

Examples

As modifyWorkbook by itself doesn't do much, relevant examples of its use can be found in the pages of the child commands. Also, take a look at the examples of evalFormulas to see how to use this command and its children to execute dynamic formula alterations

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.