Filters in Table controls based on a data file

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Table control

Table based on a data file

Filters in Table controls based on a data file

Overview

Describing the Table control

Filter property

HFilter

See also

Filters in Table controls based on a data file

Overview

WINDEV, WEBDEV and WINDEV Mobile include multiple methods to filter the records displayed in a Table control based on a data file:

Filter on the search key, defined in the description window of the Table control.
Filter property.
HFilter function.
Optional event for filtering the records of a Table control. For more details, see Events associated with Table controls.

Describing the Table control

The "Display the records whose browse item starts with" option allows you to set a filter on a Table control based on a data file.

The filter has the following characteristics:

"Starts with" filter. The condition is directly entered in the editor.
The filter is only applied to Table controls based on a data file.
The filter does not affect how the data file is read (HReadFirst, etc.)

"Use HFilter to browse the file" option unchecked

If "Use HFilter to browse the file" is unchecked, the filter will have the following characteristics:

"Starts with" filter. The condition is directly entered in the editor.
The filter is only applied to Table controls based on a data file.
The filter does not affect how the data file is read (HReadFirst, etc.)
Only the column bound to the browse item can be sorted ("Sortable" option in the "General tab").
The user will not be able to perform searches in the Table control ("Magnifier (search/filter)" option in the "General" tab).

Remark: Filter options are not available for Table controls with direct access to the data source.

"Use HFilter to browse the file" option checked

If "Use HFilter to browse the file" is checked, the filter will have the following characteristics:

"Starts with" filter. The condition is directly entered in the editor.
The filter is only applied to Table controls based on a data file.
The filter does not affect how the data file is read (HReadFirst, etc.)
The user will be able to sort the data displayed in the columns bound to key items ("Sortable" option in the "General" tab).
The user will be able to perform searches in the columns bound to key items ("Magnifier (search/filter)" option in the "General" tab).

Special case: Before opening the window that contains the Table control, if a filter was set with HFilter on the file the control is based on, the Table control will automatically filter the records displayed (filter defined directly in the editor or via the Filter property). When the window is closed, no filters will be enabled on the data file.

Caution: Check the active filter when looping through data files. As two filters cannot be enabled at the same time, only the last filter created by HFilter is kept.

Remark: Filter options are not available for Table controls with direct access to the data source.

Filter property

The Filter property can be used to dynamically set the characteristics of the filter applied to the Table control.

The filter applied uses the "Use HFilter to browse the file" option defined in the editor.

HFilter

HFilter filters the base file of the Table control. HFilter allows you to use all types of filters (including the "Starts with" filters).

If HFilter is not used in the initialization code of the Table control, it is necessary to redisplay the contents of the Table control using TableDisplay.

Remark: Table controls based on a data file that are populated automatically (by WINDEV, WEBDEV or WINDEV Mobile) are not yet populated when the initialization code is executed. The records can be filtered with HFilter.