Appearance
Button
A clickable control that writes a value to a tag when pressed.
In Studio
In Studio, double-click Button in the Components category of the Components panel. It is added to the open view, where you can drag it into place.
When to use
Use a Button to command a discrete action — start, stop, reset, acknowledge — rather than to reflect or toggle a persistent on/off state (use Toggle for that).
Properties
| Property | Type | Default | Description |
|---|---|---|---|
| Value | String | (none) | Legacy write target: when the component has no value binding at all, this static field is read directly as the tag path to write. Any normally-authored, bound button uses its binding instead and ignores this field. |
| Label | String | Button | The text shown on the button face. A bound boolean value renders as ON or OFF. |
| Write Value | String | 1 | The value written on press (One Shot and Momentary modes), or the value written when the bound tag currently reads OFF (Toggle mode). |
| Release Value | String | (none) | The value written on release (Momentary mode only), or the value written when the bound tag currently reads ON (Toggle mode). With Mode on Automatic, leaving this blank makes the button One shot instead of Momentary — see the Interaction mode section below. |
| Mode | ``, oneshot, momentary, toggle | (none) | How a press and release are sequenced: One shot writes Write Value on press and nothing on release, Momentary writes Write Value on press and Release Value on release, and Toggle writes Release Value when the bound tag reads ON, otherwise Write Value. Automatic (the default, and what every project saved before this property existed holds) infers One shot or Momentary from whether Release Value is blank. |
| Enabled | true, false | true | When false, the button makes no write and runs no event action, and its face grays out. Bindable. A bound value that cannot be trusted also disables it — fail closed: a binding that has not resolved, is loading or errored, or reads with any quality other than Good (Stale, Bad or Uncertain). Bind it to the tag or expression itself rather than to another component's property, which shows that component's static default until its own binding resolves. |
| Requires Signature | false, true | false | When true, the write is deferred to the electronic-signature dialog instead of being sent immediately; the operator must sign before the value is written. This is a component-level floor on top of whatever the bound tag itself already requires. |
| Long Press (ms) | Number | 1200 | Same contract as Label's Long Press (ms) — how long a press must be held before the long-press action fires; non-positive falls back to 1200 ms. |
| Heartbeat Tag | String | (none) | Hold-to-jog. A tag the button writes true/false/true... every Heartbeat (ms) while a momentary press (one with a Release Value) is held, so the PLC can stop the jog if the heartbeat stops. It stops before the release write and on its first failed write. Accepts {view.params.X} and {page.params.X}; if the path cannot be resolved the button refuses. Cannot be combined with a confirmation or a signature. Preview never writes it. Blank = no heartbeat. |
| Heartbeat (ms) | Number | 100 | How often the heartbeat tag toggles while the button is held, in milliseconds. Default 100, clamped to 50-5000. |
| Variant | auto, filled, grey, outline, text | auto | The button face: auto (default), filled, grey, outline or text. filled is the primary action, white text on the primary color. grey is the classic gray face with a border. outline is transparent with a primary border and text. text is transparent with no border. auto follows the project look: filled in a Daylight project, gray otherwise, so an older button does not change. |
| Shape | auto, pill, rounded, square | auto | The corner shape: auto (default), pill, rounded or square. auto is pill in a Daylight project and the classic button corners otherwise. |
| Quality Mark | standard, dim | standard | How a lost link is marked when a value this component shows has Stale or Bad quality. standard (the default) draws the quality outline and glyph over the value. dim keeps the last good value on screen, faded, with nothing drawn over it: it suits a dense panel where one lost link turns a whole column Bad. The value still reads as not live, and a binding that fails to evaluate keeps its outline either way. |
Binding
Click Bind… on the Value property and bind it to a tag or an expression to drive the live value.
To let an operator change the tag from this component, tick Bidirectional (read-write) on the binding. Without it the component only displays the value.
Writes only on interaction (press/release), not continuously. See the Interaction mode section below for how Write Value and Release Value combine.
Confirm before acting
Set confirm to ask the operator before the button acts. A plain message (e.g. Start Pump 3?) turns it on; the full form is an object: enabled, display (popover, the default, anchored to the button as in Ignition, or dialog, a centered modal), title, text ( for a new line), confirmLabel (default OK), cancelLabel (default Cancel) and style (default, warning or danger). Every member can be bound, as confirm.text and so on. An Ignition-style {enabled, text} object works as-is. Cancel has the focus, and Enter, Escape or a click outside cancels. The button acts only on Confirm, and only if it is still enabled at that moment. A momentary button (one with a Release Value) cannot pass through a confirmation, so with a confirm set it refuses to operate and says why in its tooltip.
Acknowledge all alarms
A button can carry the event action Acknowledge all alarms (ackAllAlarms, on any event such as On Click). It acknowledges every unacknowledged alarm the signed-in user may see, gateway-wide, one request per alarm, the same requests the Alarm Table makes for its Ack All. Without a source it is not scoped to the screen: it acknowledges alarms from every area of the gateway. Set source to a tag folder ([Default]Plant/Area1) to acknowledge only the alarms under that folder, using the Alarm Table's Source Filter matching (the folder and anything under it; Area1 does not match Area10; a {view.params.X} placeholder is filled in; an empty source, or one that still holds a placeholder, acknowledges nothing instead of widening). delayMs waits that many milliseconds first (0 to 60000, longer values are clamped): a Reset button can write the reset, then acknowledge the alarms once the cleared ones have gone. A second press while one acknowledge is waiting or running is ignored, and leaving the page cancels one that is still waiting. Permissions are enforced by the gateway on every request, so a user who may not acknowledge gets the refusal back: the button shows "Could not acknowledge 3 alarms." (or says the alarm list could not be read) and carries on with the rest. It does not run in the designer Preview.
Interaction mode
A button's press/release sequencing is the Mode property: One shot, Momentary, Toggle, or Automatic (the default). Automatic infers the behavior from whether Release Value is blank, exactly as buttons saved before Mode existed always did:
- One shot — Press writes Write Value; there is no release write. Automatic picks this when Release Value is blank.
- Momentary — Press writes Write Value; release writes Release Value. Automatic picks this when Release Value is set.
- Toggle — Press writes Release Value if the bound tag currently reads ON, otherwise Write Value; the button reads the tag's own state rather than tracking its own.