ControlContext :: regionFilter - Fiter condition for region
Property contains a filter condition for the current list, table or tree view. The condition applies an the current access key or on a list/tree column, when preceding the filter by a column number. For controls, that are not lists, tables or trees, the property has no affect.
For trees, the filter condition applies on the currently selected region, only. After changing the region, setting a new condition will apply on the newly selected region. The filter for the old region is still active.
Implementation overview
- Get current region filter expression
ControlContext :: regionFilter ( ) - Set filter condition
ControlContext :: regionFilter ( sRegionFilter )
Implementation details
-
Get current region filter expression
odaba::String ControlContext :: regionFilter ( )
The function returns the current region filter expression.
to list
-
Set filter condition
odaba::String ControlContext :: regionFilter ( odaba::String &sRegionFilter )
The function allows setting the current filter condition to the expression passed in sRegionFilter. The region filter has to be structured as follows:
- Searching for a text contained in the sort key string of the collection displayed is possible simply by passing the text to be searched.
- Searching for text in a special column (multiple column lists)
"theater": show all list entries containing theater in the key string
"theater&berlin": Searching all list entries containing theater AND berlin in the key string
"theater|berlin": Searching all lines containing theater OR berlin in the key string
"0:theater": Searching all lines containing theater in first column (column 0). Only one column may be defined at the beginning of the search expression, i.e. one may not combine search in different columns
- Searching for text in a special property (experienced users)
"name:theater": Searching all lines containing theater in the property name. This requires additional knowledge about properties defined for the object type displayed in the list.
Search works always case sensitive and texts to be searched for may be combined using AND (&) or OR (|).
Attention: When the search text contains spaces, those will be searched as well.
In order to reset the filter condition, an empty string may be passed.
- sRegionFilter
- Region filter
Region filter require the following syntax:
[col:]value[nextvalues]
col - is an optional column number defining the column on which the filter applies. When no column is defined, the filter applies on the current access key. Firts column is column 0.
value - is the text to be searched by odaba::String function contains() (not case sensitive).
nextvalues - are one or more text values separated by & (and) or | (or) operands. All values are checked in sequence without priority rules.
1:a|b&c|d
is true, when column 1 contains 'a' or 'b' together with 'c' or 'd'.
to list