Required: false Type: string / array Scope: Display
Contains one or more condition rules for whether to display the field or not.
Conditions can be grouped and nested using boolean operators
ORas array keys. See examples below.
A rule is a string divided into several parts by “:” (colons). The first part is the rule-type and the subsequent parts depend on the rule type.
The following rules are available:
This evaluates based on another field’s value in the record.
Part 1 is the field name
Part 2 is the evaluation type. These are the possible options:
Requires the field to have a “true” value. False values are “” (blank string) and 0 (zero). Everything else is true. For the REQ evaluation type Part3 of the rules string must be the string “true” or “false”. If “true” then the rule returns “true” if the evaluation is true. If “false” then the rule returns “true” if the evaluation is false.
- > / < / >= / <=
Evaluates if the field value is greater than, less than the value in “Part 3”
- = / !=
Evaluates if the field value is equal to value in “Part 3”
- IN / !IN
Evaluates if the field value is in the comma list equal to value in “Part 3”
- - / !-
Evaluates if the field value is in the range specified by value in “Part 3” ([min] - [max])
- BIT / !BIT
Evaluates if the bit specified by the value in “Part 3” is set in the field’s value (considered as an integer)
This evaluates based on the current record (doesn’t make sense for flexform fields)
Part 1 is the type:
Requires the record to be new if Part 2 is “true” and reversed if Part 2 is “false”.
- This will hide the field for all non-admin users while admins can see it. Useful for FlexForm container fields which are not supposed to be edited directly via the FlexForm but rather through some other interface.
userFunc call with a fully qualified class name.
Additional parameters can be passed separated by colon:
The following arguments are passed as array to the userFunc:
record: the currently edited record
flexContext: details about the FlexForm if the condition is used in one
conditionParameters: additional parameters
The called method is expected to return a
trueif the field should be displayed,
Evaluate if a record is a “versioned” record from workspaces.
Part 1 is the type:
Part 2 is “true” or “false”: If true, the field is shown only if the record is a version (pid == -1). Example to show a field in “Live” workspace only:
In FlexForm, display conditions can be attached to single fields in sheets, to sheets itself, to flex section fields and to flex section container element fields.
FIELDreferences can be prefixed with a sheet name to reference a field from a neighbor sheet, see examples below.
Fields used in a conditions should have the column option
onChange set to reload.
Simple display condition¶
This example will require the field named “tx_templavoila_ds” to be true, otherwise the field for which this rule is set will not be displayed:
'displayCond' => 'FIELD:tx_templavoila_ds:REQ:true',
Multiple conditions can be combined:
'displayCond' => [ 'AND' => [ 'FIELD:tx_templavoila_ds:REQ:true', 'FIELD:header:=:Headline', ], ],
A complex example¶
Going further the next example defines the following conditions: for the “example_field” field to be displayed, the content element must be in the default language. Furthermore it must be a text-type element or have the headline “Example” defined:
'displayCond' => [ 'AND' => [ 'FIELD:sys_language_uid:=:0', 'OR' => [ 'FIELD:CType:=:text', 'FIELD:header:=:Example' ] ] ];
A complex example in a flexform¶
AND within FlexForms works like this:
<displayCond> <and> <value1>FIELD:sys_language_uid:=:0</value1> <or> <value1>FIELD:CType:=:text</value1> <value2>FIELD:header:=:Example</value2> </or> </and> </displayCond>
Access values in a flexform¶
Flex form fields can access field values from various different sources:
<!-- Hide field if value of record field "header" is not "true" --> <displayCond>FIELD:parentRec.header:REQ:true</displayCond> <!-- Hide field if value of parent record field "field_1" is not "foo" --> <displayCond>FIELD:parentRec.field_1:!=:foo</displayCond> <!-- Hide field if value of neighbour field "flexField_1 on same sheet is not "foo" --> <displayCond>FIELD:flexField_1:!=:foo</displayCond> <!-- Hide field if value of field "flexField_1" from sheet "sheet_1" is not "foo" --> <displayCond>FIELD:sheet_1.flexField_1:!=:foo</displayCond>
Changed in version 8: The display condition parser has been rewritten. It is now “strict” and throws exceptions if the syntax of a display condition is bogus. The exception message reveals details on what exactly is broken. This helps with finding bugs in a display condition configuration and reduces headaches with “Why is my field shown or not shown?”.