Search Field Block – a search input that starts an action¶
The search field is an input with a button attached to its right side. When the user submits the search, the field runs an action and hands it the entered text. What happens with the text – a query, a navigation, a call to another system – is decided by the action.
This page is part of the widget reference.
1. At a glance¶
| Purpose | Takes a search text and starts an action with it |
| Typical use | "Find customer by number" on a start page; a search that opens a query result page |
| Related | Catalog and Query Results, which search their own records |
2. Settings¶
In addition, the widget has the settings every widget has, including "Flush".
| Setting | Meaning | Default |
|---|---|---|
| "Search Action" | The action run on submit. It gets the entered text in the special variable "Search Field Content". | none – without it the field is disabled |
| "Placeholder" | The hint inside the empty input | none |
| "Input Tooltip" | Tooltip of the input | none |
| "Button Tooltip" | Tooltip of the button | none |
| "Button Icon" | Icon on the button, an image expression | a magnifier |
| "Submit On Enter" | Pressing Enter in the input submits as well | on |
| "Clear On Submit" | Empties the input after the action has been started | off |
3. Behaviour¶
- The action runs without a record. Inside the action, the text is available as the special variable "Search Field Content" – for example in a query condition or in the target of a navigation.
- While the action runs, the button cannot be clicked again.
- With "Auto Refresh" placeholder, tooltips, icon and action are evaluated again; the text the user typed stays.
4. Example¶
Find a customer. "Placeholder" "Customer number or name", "Search Action" an action that opens the query "Customers" with a condition on number or name containing "Search Field Content".