Operator Actions

Introduction

An Operator Action is a sequence of IEC 61131-3 Structured Text (ST) Statements that run when an operator interacts with a graphic page.

The graphic editor allows you to assign different Operator Actions to each of these events:

ActionButtonDown
ActionButtonUp
ActionButtonWhileDown
ActionDoubleClick
ActionContextMenu
ActionListClickRow

ActionButtonDown

Defines the code to execute when one of the following occurs:

A user presses the left mouse button down on the item
On a touch screen, a user presses a finger on the item

The ActionButtonDown operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.

Applies to

ActionButtonUp

Defines the code to execute when one of the following occurs:

A user releases the left mouse button after first pressing the mouse button down on the item
On a touch screen, a user releases a finger on the item

The ActionButtonUp operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.

Applies to

ActionButtonWhileDown

Defines the code to execute when one of the following occurs:

A user holds the left mouse button down on the item
On a touch screen, a user holds a finger down on the item

For touch devices if ActionContextMenu is defined, ActionButtonWhileDown does not run.

The property WhileDownInterval sets the interval between each execution of the script.

The ActionButtonWhileDown operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.

Applies to

ActionDoubleClick

Defines the code to execute when one of the following occurs:

A user double-clicks the left mouse button on the item
On a touch screen, a user double taps the item

The ActionDoubleClick operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.

Applies to

ActionContextMenu

Defines the code to execute when one of the following occurs:

A user clicks the right mouse button on the item
On a touch screen, a user taps and holds a finger down on the item (long press).

For touch devices if ActionContextMenu is defined, ActionButtonWhileDown does not run.

The ActionContextMenu operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.

Applies to

ActionListClickRow

Defines the code to execute when one of the following occurs:

A user clicks the left mouse button on a selected row in a list.
On a touch screen, a user taps a finger on a selected row in a list.

The ActionListClickRow operator action will not run if:

The DataBindDisableActions data binding is defined, and evaluates to TRUE.
The DataBindVisible data binding is defined, and evaluates to FALSE.
The ActionButtonDown operator action is defined.
The ActionButtonWhileDown operator action is defined.
The ActionButtonUp operator action is defined.

Applies to

SQL List

Contextual Information

Code actions can access contextual information about the event that triggered the action using the CurrentAction variable.

The CurrentAction variable is declared as:

TYPE
    ActionType : ( ATNone, 	ATButtonDown, ATButtonMove, ATButtonUp, 
                ATContextMenu, ATDoubleClick, ATKeyDown, ATKeyUp );
    
    ActionContext : STRUCT
        (* The type of event that triggered the action *)
        OperatorActionType : ActionType;
        (* For mouse pointer events, the pointer position in canvas coordinates *)
        PointerX : REAL;
        PointerY : REAL;
        (* For keyboard events, the keycode that triggered the action *)
        KeyCode : UINT;
    END_STRUCT;
END_TYPE

VAR_GLOBAL CONSTANT VOLATILE
	CurrentAction : ActionContext;
END_VAR

Further Information

Operator Actions Editor

For how to edit Operator Actions for items on graphic pages.

Graphic Editor Toolbar

For the different tools available to edit graphic pages.

Graphic Editor

For information about editing graphic pages in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.