Interactions
Using interactions, fields can have the ability to affect the visibility of another field, block or element on the canvas. Visibility will be determined by cases, which are listed in the Interactions pane.
Note: The custom screen executes each case from top to bottom, so if two cases contradict each other, the latter case will take precedence.
To add an interaction to an element
- Click the field, block or element in the canvas to be affected by the interaction. The Affected Field in the Interactions pane (located by default in the lower-right corner of the Screen Designer interface) is defined by the field or block you click in the canvas.
- Click New to start designing your interaction.
- In the If section of the Interactions pane, formulate a logic condition using the following three fields: Selected Field, Operator, and Value.
- In the Selected Field drop-down list, select the field in the canvas that will affect the defined Affected Field.
- Select an Operator from the drop-down list. The available operators will depend on the field type of the Selected Field.
- In the Value field, enter a value to compare to the Selected Field with the selected Operator. The Value field can be a text field or a drop-down list depending on the field type of the Selected Field.
- In the Then section of the Interactions pane, define how the Affected Field will be affected if the If condition returns a true value.
- Select a Visibility value.
- Selecting Show will force the Affected Field to display on the custom block if the If condition is true.
- Selecting Hide will force the Affected Field to not display on the custom block if the If condition is true.
- Selecting N/A will not affect the visibility of the Affected Field, regardless of the value of the If condition.
- Select the Required check-box to make the Affected Field required on the custom block if the If condition is true.
- Alter the appearance of the label font with the following fields: Label Font-Family, Label Font-Size, Label Font-Color.
- Select the label font from the Label Font-Family drop-down list.
- Enter the label font size in the Label Font-Size field.
- Click the Color button to define the label font color.
- Alter the appearance of the value font with the following fields: Value Font-Family, Value Font-Size, Value Font-Color.
- Select the value font from the Value Font-Family drop-down list.
- Enter the value font size in the Value Font-Size field.
- Click the Color button to define the value font color.
- Select a Visibility value.
- Click Save. If you edit an interaction, you must save prior to editing a new interaction or the first changes will not be recorded.
Important: After creating an interaction, the inverse condition is automatically created. Users do not need to manually define the opposite of their action. This applies to both show/hide functionality as well as required/not required and will only apply to newly created interactions. As an example, if a user set a given field to "show" if the Current Phase is "Closed," the user does not need to manually create a "hide" condition for all phases besides "Closed."
Users should thereby make sure when deleting interactions that they remove both interactions, as unintended duplicate interactions can result from creating new interactions after only deleting half of the pre-existing interaction. This automatic inverse creation does not apply to numeric-type fields.
After saving an interaction on a field or element in the canvas, you can add more interactions to the same field or element by clicking the New button in the Interactions pane.
Note: A list field that has been turned into a radio button list using the radioButtonList property cannot be made required for interactions.
Operators
The table below displays all the operators that are available for interactions in Screen Designer.
Operators |
Description |
---|---|
Equals |
Returns true if the Selected Field is equal to the entered Value. |
Not Equals |
Returns true if the Selected Field is not equal to the entered Value. |
> |
Returns true if the Selected Field is greater than the entered Value. This operator is only available for numeric fields. |
=> |
Returns true if the Selected Field is greater than or equal to the entered Value. This operator is only available for numeric fields. |
= |
Returns true if the Selected Field is equal to the entered Value. This operator is only available for numeric fields. |
=< |
Returns true if the Selected Field is less than or equal to the entered Value. This operator is only available for numeric fields. |
< |
Returns true if the Selected Field is less than the entered Value. This operator is only available for numeric fields. |
Is Null |
Returns true if the Selected Field contains a null value. |
Is Not Null |
Returns true if the Selected Field contains any value other than null. |
Contains |
Only available for List fields. Returns true if the Selected Field contains any of the selected options. Users can use shift to select multiple values from the available list. Selecting multiple values for Contains operates with "Or" logic. As an example, if the multi-select list has values "A, B, C, D, E," and a user selects B and D, the Interaction will be triggered if either value matches. If none of the values match, the interaction will not be triggered. |
Does Not Contain |
Only available for List fields. Returns true if the Selected Field does not contain any of the selected options. Users can use shift to select multiple values from the available list. Selecting multiple values for Does Not Contain operates with "AND" logic. As an example, if the multi-select list has values "A, B, C, D, E," and a user selects B and D, the Interaction will be triggered if both values are not present. If either of the values match, the interaction will not be triggered. |