Page tree
Skip to end of metadata
Go to start of metadata

Graphic object manipulation functions

For purpose of communication with individual graphic objects, there are implemented functions, which look like functions commonly used in the expressions of eval tags or scripts. Function names are created by the prefix %HI_.

For example:

%HI_SetVisible(_Button1, @FALSE)

or

BOOL _visible
 _visible := %HI_GetVisible(_Button1)

The first example controls the visibility of the graphic object with the reference variable _Button1.
The second example detects current state of the graphic object visibility.

The examples imply that functions are used in two contexts:

  1. To set a graphic object property (visibility in this case). It is so-called Control function.
  2. To detect the state of the graphic object property.

Functions to set properties of graphic objects do not get values and they can not be used in expressions. Functions to detects the state (value) of graphic object properties get values and they can be used in expressions.

Let's call the first set of functions GET functions and the second set SET functions.

The first parameter of GET and SET functions is the value of the reference variable of particular graphic object. It is usually the reference variable (e.g. Button1). When such a function is executed, there is always checked whether the graphic object (connected to the reference variable) exists. If the graphic object doesn't exist, the script interpreter generates the error _ERR_UNKNOWN_REFID, which is standardly processed by the error handler (see the action ON ERROR).

Each function is able to control only some types of graphic objects. If the script interpreter detect an illegal use of a function for specific type of graphic object during the function execution, the interpreter generates the error _ERR_INVALID_REFID_TYPE.


%HIX_  functions

Some %HI_ functions are also available in %HIX_ version. These functions are able to redirect the function executing to another picture (through the first two parameters).

Example: Function %HI_ClosePicture() is available in %HIX_ClosePictur (IN HBJ _picHBJ, IN INT _KInstance). %HI_ClosePicture closes picture in which it has been called. %HIX_ClosePicture closes picture defined by HOBJ (internal object identifier) and instance. Meaning of HOBJ and instance is the same as it is in the case of RPC CALL (parameters objIdent and instanceExpr).

If function %HIX_ is applied, the ESL script must be implemented to picture (it must be Active picture).


Types of functions:

List of graphic object manipulation functions


Graphic objects manipulation functions:


List box manipulation functions:


List box and Tree view manipulation functions:


Tree view manipulation functions:


List box, Tree view and Browser manipulation functions:


Text entry field and List box manipulation functions:


Text entry field manipulation functions:


Text entry field -RichEdit manipulation functions:


Browser (displayer) manipulation functions:


Report(displayer) manipulation functions:


Graph (displayer) manipulation functions and actions:


Graph and Picture (displayer) manipulation functions:


Graph (displayer) and XY Graph manipulation functions:


XY Graph manipulation functions:


Logging manipulation functions:


Alarms manipulation functions:


WebFrame (displayer) manipulation functions:


Functions supporting Drag&Drop:


Other functions:


Note

  • Functions, whose name begin with the string %HI_Get... get values and they can be used in expressions.
  • The other functions are so-called Control functions.
Write a comment…