Get Range
Reads data from a range of cells and returns it as a table structure with columns and rows.
Common Properties
- Name - The custom name of the node.
- Color - The custom color of the node.
- Delay Before (sec) - Waits in seconds before executing the node.
- Delay After (sec) - Waits in seconds after executing the node.
- Continue On Error - Automation will continue regardless of any error. The default value is false.
info
If ContinueOnError property is true, no error is caught when the project is executed even if the Catch node is used.
Input
- File Descriptor - File descriptor of the Excel file. This is the identifier returned by the Open Excel node.
- From Cell - Starting cell of the range (e.g.,
A1). Required when Range is "Specific-Range". - To Cell - Ending cell of the range (e.g.,
C10). Required when Range is "Specific-Range".
Output
- Table - Table object containing
columnsandrowsarrays. The structure depends on the Headers option:- With headers: Column names from first row, data from remaining rows
- Without headers: Column names are cell addresses (A, B, C, etc.)
Options
- Range - Whether to read all used cells or a specific range:
Specific-Range- Read a specific range (requires From Cell and To Cell)All-Range- Read all cells with data in the active sheet
- Headers - Whether the first row contains column headers. Default is
false.true- First row is treated as column namesfalse- Column names are cell addresses (A, B, C, etc.)
- Include Hyperlinks - Whether to include hyperlink information. Default is
false.false- Returns cell values onlytrue- Returns objects withtextandhyperlinkproperties
Example
Reading all data without headers:
// File Descriptor: message.excel_fd
// Range: All-Range
// Headers: false
// Output: message.table
// Structure: { columns: ["A", "B", "C"], rows: [{A: "val1", B: "val2", C: "val3"}, ...] }
Reading a specific range with headers:
// From Cell: "A1"
// To Cell: "D10"
// Range: Specific-Range
// Headers: true
// Output: message.table
// Structure: { columns: ["Name", "Age", "City", "Score"], rows: [{Name: "John", Age: 25, ...}, ...] }
Reading data with hyperlinks:
// From Cell: "A1"
// To Cell: "B5"
// Range: Specific-Range
// Headers: true
// Include Hyperlinks: true
// Output includes: { text: "Click Here", hyperlink: "http://example.com" }
Processing the table data:
// After Get Range, iterate through rows
// For Each node with message.table.rows
// Access columns: message.item.ColumnName
Tips
- The table structure is compatible with Set Range for copying data between sheets.
- Use Headers: true when your data has column names in the first row for more readable code.
- All-Range reads only the "used range" (cells that have or had data), not the entire worksheet.
- When Include Hyperlinks is enabled, each cell value becomes an object with
textandhyperlinkproperties. - The output can be directly passed to other nodes that accept table format.
Common Errors
| Error | Solution |
|---|---|
| From Cell cannot be empty when Range is Specific-Range | Provide a starting cell address |
| To Cell cannot be empty when Range is Specific-Range | Provide an ending cell address |
| Range must be selected | Choose either Specific-Range or All-Range |
| Invalid File Descriptor | Ensure the Open Excel node was executed first |