Write Range (Excel)

Writes data from a DataTable to an Excel worksheet.

Behaviour

Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash

Package Excel activities Velophex.Excel.Activities 0.7.1-rc.7 · Supported (Core profile) · type id velophex.excel.writeRange

Properties#

Input#

Sheet#

Sheet · String · Required · Default: Sheet1

The name of the sheet.

Starting Cell#

StartingCell · String · Optional · Default: A1

The top-left cell address (e.g. 'A1'). Defaults to A1.

Data Table#

DataTable · DataTable · Required · Default: Not specified in package metadata

The DataTable to write.

Workbook#

Workbook · ExcelWorkbookReference · Optional · Default: Not specified in package metadata

The Excel file to use. Empty uses the innermost enclosing Use Excel File; set it to the Reference As name of a Use Excel File to use that one.

Options#

Include Headers#

IncludeHeaders · Boolean · Optional · Default: True

True to write column headers as the first row.

Rules#

  • Must be inside Use Excel File.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, range, write, datatable, table.

Properties

Input

Options

Rules

Retry and risk

Related activities