Read Range (Workbook)
Reads a range of a workbook file's sheet into a DataTable, without Use Excel File.
Behaviour
Risk: None · 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.workbook.readRange
Properties#
Input#
Workbook Path#
WorkbookPath · String · Required · Default: Not specified in package metadata
The .xlsx or .xlsm file. Relative paths resolve against the project folder.
Sheet#
Sheet · String · Required · Default: Sheet1
The name of the sheet.
Range#
Range · String · Optional · Default: Not specified in package metadata
The range in A1 notation. Empty reads the used range.
Options#
Add Headers#
AddHeaders · Boolean · Optional · Default: True
The first row holds the column names.
Output#
Data Table#
DataTable · DataTable · Output
The cells read.
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.
Related activities#
- Append Range (Workbook)
- Get Sheets
- Get Table Range
- Read Cell (Workbook)
- Read Cell Formula
- Read Column (Workbook)
- Read Row (Workbook)
- Write Cell (Workbook)
Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Workbook. Keywords: workbook, xlsx, spreadsheet, range, read, datatable, table, file.
Properties
Input
Options
Output
Retry and risk
Related activities