Match Function
Returns the position of a value in one row or one column, as Excel's MATCH.
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.match
Properties#
Input#
Sheet#
Sheet · String · Required · Default: Sheet1
The name of the sheet.
Range#
Range · String · Required · Default: Not specified in package metadata
One row or one column to search.
Value#
Value · Object · Required · Default: Not specified in package metadata
The value to find.
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#
Match Type#
MatchType · String · Optional · Default: Exact
Exact: the first equal value. LessThan: the largest value not greater, list ascending. GreaterThan: the smallest value not smaller, list descending.
Allowed values: Exact, LessThan, GreaterThan.
Output#
Position#
Position · Int32 · Output
The 1-based position in the range, or -1 when there is no match.
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.
Related activities#
- Append Range (Excel)
- Auto Fill
- Auto Fit Range
- Clear Range
- Copy Paste Range
- Copy Sheet
- Create Sheet
- Create Table
Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, match, position, index, find.
Properties
Input
Options
Output
Rules
Retry and risk
Related activities