Filter Range

Applies an autofilter on a specified range and column.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

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

Properties#

Input#

Sheet#

Sheet · String · Required · Default: Sheet1

Worksheet name.

Range#

Range · String · Required · Default: Not specified in package metadata

Range address to filter (e.g. A1:E100).

Column Index#

ColumnIndex · Int32 · Required · Default: 1

1-based column offset in range.

Filter Value#

FilterValue · String · Required · Default: Not specified in package metadata

Criteria value to filter by.

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.

Rules#

• Must be inside Use Excel File.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. 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, filter, autofilter, range.

Properties

Input

Rules

Retry and risk

Related activities