TableEnableFilter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Benefits of user filters

Special cases

See also

TableEnableFilter (Function)

In french: TableActiveFiltre

Implements a user filter on a column found in a Table or TreeView Table control. This filter can be disabled by the user or by TableDisableFilter.

Remark: When a user filter is defined on a Table or TreeView Table control, the following icon is displayed in the column header:

The user can delete the filter:

via the "Delete the filter" option from the popup menu of "funnel" icon. The user filters are included in the AAFs (Automatic Application Features) available for the Table and TreeView Table controls. For more details, see AAF on the columns of a Table control.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Example

// Filters the Company column to display the companies starting with "Fl"
TableEnableFilter(TABLE_Customer.COL_Company, filterStartsWith, "Fl")

Syntax

TableEnableFilter(<Table control.Column> , <Type of filter> , <Filter value>)

<Table control.Column>: Character string (with or without quotes)

Name of the column where the user filter must be enabled. This name has the following format:

<Name of Table control>.<Column name>

<Name of Table control> can correspond to the name of a Table or TreeView Table control.
Example:

TABLE_CustomerTable.COL_CompanyName

<Type of filter>: Integer constant

Type of filter to apply. This filter can be chosen among the following values:
filterStartsWith Displays the rows whose value for the specified column "Starts with" the characters specified in <Filter value>.
filterContains Displays the rows whose value for the specified column "Contains" the characters specified in <Filter value>.
filterDifferent Displays the rows whose value for the specified column "Differs" from the characters specified in <Filter value>.
filterEqual Displays the rows whose value for the specified column "Is equal" to the characters specified in <Filter value>.
filterLessOrEqual Displays the rows whose value for the specified column "Is less than or equal to" the characters specified in <Filter value>.
filterLess Displays the rows whose value for the specified column "Is less than" the characters specified in <Filter value>.
filterDoesNotStartWith Displays the rows whose value for the specified column "Does not start with" the characters specified in <Filter value>
filterDoesNotContain Displays the rows whose value for the specified column "Does not contain" the characters specified in <Filter value>.
filterDoesNotEndWith Displays the rows whose value for the specified column "Does not end with" the characters specified in <Filter value>.
filterGreaterOrEqual Displays the rows whose value for the specified column "Is greater than or equal to" the characters specified in <Filter value>.
filterGreater Displays the rows whose value for the specified column "Is greater than" the characters specified in <Filter value>.
filterEndsWith Displays the rows whose value for the specified column "Ends with" the characters specified in <Filter value>.

<Filter value>: Type corresponding to the filtered column

Value that must be given to the filter. If this parameter corresponds to an empty string (""), the filter is disabled.

Remarks

Use conditions

This function is available for a memory or browsing control.

Benefits of user filters

The user filters can be modified by the end user (unlike a filter implemented by HFilter or by Filter).

Special cases

If a user filter is already enabled on the specified column, TableEnableFilter cancels the existing filter and replaces it by the new one.
Filter does not allow you to find out the user filter used.
Versions 18 and later
TableFilteredColumn allows you to find out the user filters (defined by the user directly or by TableEnableFilter).
New in version 18
TableFilteredColumn allows you to find out the user filters (defined by the user directly or by TableEnableFilter).
TableFilteredColumn allows you to find out the user filters (defined by the user directly or by TableEnableFilter).

Business / UI classification: UI Code

Component: wd260obj.dll