Operator Actions

Help Contents

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

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

The ActionButtonDown operator action will not run if either of the following are true:

Applies to


ActionButtonUp

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

The ActionButtonUp operator action will not run if either of the following are true:

Applies to


ActionButtonWhileDown

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

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

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

The ActionButtonWhileDown operator action will not run if either of the following are true:

Applies to


ActionDoubleClick

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

The ActionDoubleClick operator action will not run if either of the following are true:

Applies to


ActionContextMenu

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

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

The ActionContextMenu operator action will not run if either of the following are true:

Applies to


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.