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.
The user can delete the filter:
via the "Delete the filter" option in the context 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. 
via the "Delete the filter" option from the menu opened by clicking the "funnel" icon. User filters are among the available features in Table controls (Browser or Ajax) and TreeView Table controls. 
by defining a new filter on a column.
// 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
Name of the column where the user filter must be enabled. This name has the following format:
<Table control>.<Column control>
<Table control> can be 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: | |
| 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 "Is different" from 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>. |
| filterDoesNotStartWith | Displays the rows whose value for the specified column "Does not start with" the characters specified in <Filter value> |
| filterEndsWith | Displays the rows whose value for the specified column "Ends with" 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>. |
| filterGreater | Displays the rows whose value for the specified column "Is greater than" 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>. |
| filterLess | Displays the rows whose value for the specified column "Is less than" 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>. |
| filterStartsWith | Displays the rows whose value for the specified column "Starts 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
This function is available on:
- a Table or TreeView Table control based on a data file.
- a Table or TreeView Table control populated programmatically.
The user filters can be modified by the end user (unlike a filter implemented by
HFilter or the
Filter property).
- If a user filter is already set on the specified column, TableEnableFilter overrides the existing filter and replaces it with the new one.
- The Filter property cannot be used to identify the current user filter.
- TableFilteredColumn allows you to identify the user filters (defined by the user or defined with TableEnableFilter).
Business / UI classification: UI Code