Skip to main content
Version: 2024

universal_search_filter

title: Search, filter, and sort​

Introduction​

This guide explains which features and components you can use for adding search and filter functionality to your end application that uses the Universal GUI.

Sort​

In a grid, users can change the sort order by using the arrow icons next to the column headers. The sorting is saved and restored when the component loads again.

To find a specific word in a grid, users can enter the item they are looking for in the Search field. The Search field is permanently visible on a screen. It filters several columns at the same time. Hovering over the field shows the columns that are filtered. Only the rows that contain the search term are shown.

  • To remove the search term and its results, users can select Clear Remove.
  • If not enough space is available to display the Search field, users can select Search Search.

To configure the Search configuration for your end application, see Combined filter.

The Search field and some prefilters

To find a specific menu item, users can enter the item they are looking for in the Menu search field. Only the menu items that contain the searched item are shown.

Search for 'user' in the Menu search fields, with two results

Filter (popup)​

In the Filter popup, users can set the operators and values for filtering the available fields. To set up a filter, users can open the overflow menu menu, and select Filter.

In the popup, users can:

  • Set the operators and values for the available fields.
  • Select Reset to return the popup to its initial settings.
  • Select Filter to close the popup and filter the subject.
  • Save a filter as a prefilter, see Prefilter.

To configure the filter for your end application, see:

Filter form​

A Filter form is a screen component that you can add to a screen in your end application.

To users, it is always visible in their screen, they can use it to filter data in the grid. The data is filtered immediately when they select Enter. When data in a column is filtered, the column header displays the icon filter.

  • Users cannot change conditions (e.g., "larger than" or "not equal to").
  • The following data is not yet suitable for filtering: columns with a date, time, label, group header label, group header icon, HTML, RTF, SQL editor, multi-line, image link, image upload, image BLOB (binary large object), file, file upload, signature, video link.

A filter form in the Universal GUI

Prefilter​

To find a data set that meets specific criteria, users can toggle between predefined filters, called prefilters. Prefilters are similar to regular Filters, but do not allow user input. They only show rows that meet the criteria.

For example, for a screen with project details, you can define prefilters for the project status. You have defined prefilter In progress as active by default. If a user opens the screen, only the projects with status In progress are shown. They can disable this prefilter and select the prefilter Planned to see all the planned projects. Disabling all prefilters would show all the projects.

  • To activate prefilters, users can select a prefilter button in the prefilter bar. The lines underneath the buttons indicate which prefilter are active.
  • To deactivate a prefilter, users can deselect the prefilter button.
  • If not enough space is available to display the prefilters, users can select menu to see all (additional) filters.

To configure prefilters for your end application, see Prefilter.

The Search field and some prefilters. The underlined prefilter is active

User preferences for prefilters​

The Universal GUI can remember and apply a user's default prefilter state preference. For example, if a user deactivates a prefilter that was initially activated, and returns to the same screen, the prefilter will remain deactivated by default.

To configure the prefilter status, see User preferences availability.

User-defined prefilters​

Users can manage their custom filters from the overflow menu menu with the option Own prefilters. In this menu, users can:

  • Select Create new prefilters to add a new prefilter.

  • Select Edit Edit to change the selected prefilter.

  • Select Delete Delete to remove selected prefilter.

  • Save edited prefilters as new prefilters with a different name: The Save button contains the option "Save as new prefilter". After saving, the prefilter is automatically updated and becomes available in the toolbar for the specific subject.

    Save as prefilter Save as prefilter

Quick filter​

To filter for a specific value, users can select a cell, open the overflow menu menu, and select Quick filter. The column of the selected cell is filtered against the value of the selected cell with the condition is equal to.

  • Due to some technical limitations, the quick filter is not available for all data types.
  • If the overflow menu or the Quick filter option is not visible, filtering is not allowed.
  • When the quick filter is applied to a column for which a filter has been defined already, the first filter is cleared from the column.
  • To disable a quick filter, the user selects the same cell and selects Quick filter a second time.

No further configuration is required for the quick filter.

Quick filter The overflow menu with Quick filter and Clear all filters

Filter in a column header​

If a column contains a domain or lookup column with elements, users can filter the values from the grid header. For example, for column 'Invoices' with a COMBO control, users can filter in the header on 'Paid', 'Unpaid' and 'Overdue'.

See:

Clear all filters​

To clear all filters, users can open the overflow menu menu and select Clear all filters.

If this option is disabled (greyed out), no filter is active.

Was this page helpful?