UiPath Activities

The UiPath Activities Guide

UiPath.Excel.Activities.Business.FilterX

Creates a filter in a range, table, or sheet based on the values in a single column. Can also be used to clear existing filters. To filter for multiple columns across a single range/sheet/table, you must use multiple Filter activities targeting the same source range. The activity can be used with an Excel file selected for a parent Use Excel File activity or with the Project Notebook.

When you use this activity to create a filter and a filter already exists:

  • If the existing filter is applied to the defined source range, the existing filter is not cleared (both filters are applied).
  • If the existing filter is applied outside of the defined source range:
    • If the defined source range is a sheet or a range of cells, the existing filter is cleared and the new filter is applied.
    • If the defined source range is a table, the existing filter is not cleared.

When you use this activity to clear existing filters:

  • If a column is defined in Column name, only the filter from the specified column is cleared. The defined source range must match the range filtered by the column.
  • If Column name is empty:
    • If the defined source range is a sheet or a range of cells, all the filters are cleared from the entire sheet.
    • If the defined source range is a table, all the filters are cleared from that table only.

To learn how to use this activity, see Tutorial: Filtering Data in Excel.

Configuring the Activity

In the Body of the Activity

  • Source range - Click Plus plus buttonplus button on the right side of the field, select the file, and then select a named range, table, or sheet to filter, or select Indicate in Excel to open the file and select a range directly from the file. To enter a range, table, or sheet manually, select Custom Input.
    Alternatively, you can select Open in Advanced Editor and enter a VB expression.
  • Column name - Click Plus plus buttonplus button on the right side of the field, select Range, and then select the header of the column to filter on. Alternatively, you can select Text to enter the value in the column header in the Text Builder, or select Open in Advanced Editor and enter a VB expression.
  • Configure Filter - Click this button to configure the filter for the values in the column. You can use a basic filter to enter one or more values to filter on, or an advanced filter to specify conditions using comparison operators in a similar way to how you configure a Custom AutoFilter in Excel.
  • Clear any existing filter - Select this option if you want to clear existing filters instead of creating a new one. Clearing filters does not remove filter configurations from inside the activity, if any were defined.

In the Properties Panel

Common

  • DisplayName - The name displayed for the activity in the Designer panel.

Input

Misc

  • Private - If selected, the data used in the activity is not logged by StudioX.

Options

Updated 3 months ago


Filter


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.