FILTER functions

Filter functions are used to implement custom filters. These filters can be used to select Text Blocks in a Text Block List.

Filter functions are specified using the FILTER keyword. Filter functions can only be defined in Code Libraries, and they cannot be defined in conditional statements or other nested constructs.

FILTER FUNC BOOL filter (FIELDSET Properties)
DO
  ...
OD

A filter function must return TRUE if the Text Block should be included in the View, or FALSE if it should be excluded. The filter function can use the function metadata_contains to test for metadata attributes that are set on the Text Block.

Filter functions have access to the Data Backbone through the _data variable and can use any KCM language functionality. Attributes of the specific Text Block can be accessed through the FIELDSET parameter.