Boolean Button¶

Widget for writing 0 or 1 to the attached PV. This widget can also be used to flip a single bit of the attached PV.

Basic Properties

Name (name)

Human-readable name of this widget. Shown in the Outline view.

PV Name (pv_name)

The name of the main PV for this widget. If set, the widget’s value follows value updates of the corresponding PV.

It is not a requirement to use a PV. You may also control the widget value directly through scripting.

Widget Type (widget_type)

Readonly property describing the type of this widget.

Behavior Properties

Actions (actions)

Executable Actions attached to this widget.

Bit (bit)

Matches the widget’s boolean value to a specific bit of the attached PV’s value.

If -1, any non-zero value is considered true, whereas a zero value is considered false.

This widget writes the numeric values 0 (unselected) or 1 (selected) to the PV.

Confirm Message (confirm_message)

The message to be displayed when Show Confirm Dialog is set.

Data Type (data_type)

Control how the widget boolean value is established.

Code	Value	Description
0	Bit	The widget boolean value matches a specific bit (indicated by the Bit property), or the entire value in case the Bit property is set to -1
1	Enum	The widget boolean value follows the comparison of its value with specific enumeration states (indicated with the Off State and On State property

Enabled (enabled)

Unset to make this control widget unusable.

Off State (off_state)

If Data Type is set to Enum, this indicates the state that matches boolean false.

On State (on_state)

If Data Type is set to Enum, this indicates the state that matches boolean true.

Password (password)

If set, this contains the password that needs to be provided by the user when Show Confirm Dialog is set, and the user is attempting to change the widget state.

Note

OPIs are rendered on the client. The use of this property provides only a false sense of security.

Push Action Index (push_action_index)

Index in the list of associated actions of the action that must be executed when the control is pushed.

Release Action Index (release_action_index)

Index in the list of associated actions of the action that must be executed when the control is released.

Rules (rules)

Rules attached to this widget.

Scripts (scripts)

Scripts attached to this widget.

Show Confirm Dialog (show_confirm_dialog)

Show a confirm dialog when an attempt is made to change the widget state.

If the Password property is set, the user will be asked to enter that password correctly.

Toggle Button (toggle_button)

If yes, this button stays engaged after clicking it. You need to click it a second time to untoggle it.

If no, this button stays engaged only for as long as the mouse stays pressed.

Visible (visible)

Manage the visibility of this widget.

Border Properties

Alarm Sensitive (border_alarm_sensitive)

If the PV is in alarm state, the widget border and style change to alarm mode.

Border Color (border_color)

The color of the widget border.

Has no meaning with certain types of border styles (for example, raised borders have a fixed style).

Border Style (border_style)

The type of border. Some border styles also colorize the background of the widget’s bounding box.

Border Width (border_width)

The thickness of the widget border.

Has no meaning with certain types of border styles (for example, raised borders have a fixed style).

Display Properties

3D Effect (effect_3d)

Whether the rendering includes gradient and shadow effects.

Alarm Pulsing (alarm_pulsing)

If enabled, the PV is in alarm state, and the properties BackColor Alarm Sensitive and/or ForeColor Alarm Sensitive are used, then the corresponding colors will fade in and out to draw operator’s attention.

BackColor Alarm Sensitive (backcolor_alarm_sensitive)

If the PV is in alarm state, then Background Color matches the corresponding alarm color.

Background Color (background_color)

The color of the background of the widget’s bounding box. Only visible when the widget uses a border style that fills up the widget area.

Font (font)

The font of the label.

ForeColor Alarm Sensitive (forecolor_alarm_sensitive)

If the PV is in alarm state, then Foreground Color matches the corresponding alarm color.

Foreground Color (foreground_color)

The color of the label.

Labels from PV (labels_from_pv)

If the PV is an enumerated PV, retrieve the labels for the on/off states from the associated PV.

Off Color (off_color)

Color of the LED when it is off.

Off Label (off_label)

The label text when this widget’s boolean state is false.

On Color (on_color)

Color of the LED when it is on.

On Label (on_label)

The label text when this widget’s boolean state is true.

Show Boolean Label (show_boolean_label)

Whether the label is visible (controlled with properties Off Label and On Label).

Show LED (show_led)

Whether the LED is visible.

Square Button (square_button)

Make the button rectangular.

Tooltip (tooltip)

Tooltip when mouse hovers this widget.

Position Properties

Height (height)

Height of the widget area in pixels.

Scale Options (scale_options)

If autoscaling is enabled on the Display, then this property allows controlling whether and how this widget participates.

Width (width)

Width of the widget area in pixels

X (x)

X-coordinate in pixels of the top-left corner of the widget area.

Y (y)

Y-coordinate in pixels of the top-left corner of the widget area.