| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
This page is for data modellers or application developers who want to apply special formatting to data that meets specific criteria.
Overview
A formatting rule allows you to specify an expression which evaluated can apply the selected style to the parent object. It allows to apply styles conditionally, depending on current values displayed on the screen; see Applying Formatting Rules for some examples.
A formatting rule can be applied to a view attribute or to a component. If you apply a formatting rule to a template component, all components created from the template will have a copy of the formatting rule applied.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description |
|---|---|
| Rule Expression | Expression to be evaluated on order to determine should the Style be applied. This expression takes PhixFlow Internal Variables. See examples below. For more help on expressions, see Regular Expressions and Expressions and PhixScripts. |
| Style | Style to be applied when the Rule Expression evaluates to true. |
| Order | Order of the Rule Expression. |
| Enabled | Flag showing is the Rule Expression enabled. |
| Stop If True | Flag showing if other rules shouldn't be applied if the current Rule applies. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example
For the Status Type attribute in a view, set the properties to:
Properties
For the Status Type attribute in a view, set the properties to:
- Rule Expression:
- either
_field.value == "OK" - or
_current.StatusSummary=="Validation Passed"
- either
- Style:
BackgroundColour-LightGreen - Enabled:
Insert excerpt _check_box_tick _check_box_tick nopanel true
_field.value == "OK" identifies the status type of OK and highlights the cell
_current.StatusSummary=="Validation Passed"
Resulting View
This displays the OK field with a green background.
Formatting Rule Expressions
Variables
In formatting rules, you can use the following Internal Variables.
- To determine the maximised state of a screen, use _screen. In a formatting rule, use the state of this variable to set the button icon. This means the button can match the current maximised state of the screen.
- To act on a specific record use one of the following:
| Formatting expression variable | Where can the variable be used? | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Description | Viewdirectly on a screen | Form on a screen | View on a form | Form on a card | Grid on a card | Card | Form Fields | |||
| acts Acts on the record | na | Provides access the the data currently displayed on the form | currently displayed on the form | currently displayed on the cardbacking the card | ||||||
_grid acts on the record | na | na | na | |||||||
| _current acts on the record | currently displayed in the grid. e.g. _form.MyAttribute | n/a | Yes | Yes | Yes | |||||
Acts on the record(s) | References the record currently selected on a grid. e.g. _grid.MyColumn | Yes, can be used in actions to get details of the selected record. | Yes, can be used to reference a selected grid item. | Yes, can be used to reference a selected grid item. | Yes, can be used to reference a selected grid item. | |||||
Acts on the record(s) | use _current in expressions for the CSS Properties of grid rows or cards. e.g. _current.AnyColumn | currently displayed in the grid | n/a | currently displayed in the cardcurrently displayed in the grid | n/a | |||||
_selected acts Acts on the record | The currently selected item | na, i.e. The selected record or card. e.g. _selected.AnyField | n/a | Currently selected field | na | Currently selected card or field on the card Currently selected field | na | _value acts on composite components | na. | n/a |
The value held in the form field. | The value held in the form field. e.g. if _field.value > 100 | n/a | Access the value in the field | na | Access the value in the field | nan/a | ||||
Functions
For quick changes to screen appearance, you want formatting rules to be evaluated quickly. To ensure a quick response, only use the attribute functions that are evaluated by the client rather than the server; see the list of Responsive Attribute Functions.
| Live Search | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Learn More
- Applying Formatting Rules
- Making Template Components
- Screen Structure
- Sizing and Positioning Screen Content
- Style
- CSS Properties
For links to all pages in this topic, see Designing Screens.