Picture local variables
Local variables are variables, that are valid within a picture instance. It
means that the same picture, opened on several consoles (processes D2000 HI) at the same time, uses its copies of local variables. Local variable
are visible within the picture script, in the system level are not available.
They can be connected to graphic object and Windows controls.
There are four categories of picture local variables:
- Basic local variables – they have no special features and can be connected to object and manipulate the object value.
- Input-output local variables – they allow to give parameters to the picture opened from other picture in both directions.
- Reference local variables - they are used for identification of graphic objects and Windows controls. Such variables are used as unique identifiers of these objects within the picture script.
- Indexed - they are used to handle current displayed row of structured variable connected to graphic object to view.
Configuration of local variables
Clicking the button Main toolbar opens the dialog box allowing to configure local variables.
from theDefinition of a local variable consists of the following attributes:
First column | The column is used to select given local variable in the list. Double-click on the column corresponds to clicking the button OK in the dialog window. After inserting graphic objects from clipboard into picture, the column shows symbols for added local variable or name or definition conflict. |
Variable name | Local variable name. The name can be used either for connection to picture graphic object or in the picture script. The name must begins with the character '_' (underline). |
Value type | Local variable value type. Possible types:
|
Value | The attribute is valid only for reference variable and defines its value for use in the picture script. |
Category | Category of the local variable. According to selected category, local variables in the list are shown in corresponding colors:
|
Structure | The attribute is valid only for the value type STRUCT and defines
the object of
Structure definition type, that determines the type of
structured local variable. The attribute is also valid for index local variable that handles a filter (detailed description in index local variables below). |
Filter type | Filter type of index local variable (detailed description in index local variables below). |
Status text | Object of Status text type, that will be used for displaying the value of the local variable when it is connected to graphic object. |
Use of local variables
Basic variables | They are used for connect to graphic objects / Windows controls. Connection is being performed in the palette
Connect object - the tab Connect.
Using such a connected local variable allows to read or modify the object contents. |
||
Input-output variables | They are used for parameter passing among pictures. Among
pictures they are paired by name - when a picture is being opened from mother picture, the contents of mother picture variables is copied into
input-output variables with the same names in the opened picture. Before
closing the new picture, new contents of the input-output variables is copied to corresponding mother picture variables. |
||
Reference variables | They are used to name (identification) objects. There are three cases, you need to identify an object:
|
||
Indexed variables | They are used to handle current displayed row of structured
variable connected to graphic object to view. Handling the value of indexed
variable from the picture script you can change current connected structure
row. The change of value in the picture ensures the change of value of
variable but not the connected row of structure. Index variables can handle so-called filter. Filter allows optimization of the communication between the processes D2000 Server and D2000 HI by distribution of the values of the row defined by the indexed variable and not the values of whole structured variable. In the case, the indexed variable must be bound with an structured variable using the attribute Structure. Filter type is defined in the attribute Filter type:
When the filtering is enabled, value distribution can be also handled by the functions %HI_OpenRow, %HI_CloseRow, %HI_ChangeRow. |
Note:
List of local variables is sorted first by category (the column
Category) and then by name (the column Variable name). Dialog box of
local variables keeps the last sorting when it is reopened.
When a conflict is occurred (see the chapter
Inserting graphic objects from clipboard into picture), the list is sorted
only by name.
Clicking on header of some column classifies the list downwardly, next clicking
classifies it upwardly.
When the local variable is editing from the
Connect object palette, tab
Script, the appropriate row in the dialog window of local variables is
color highlighted (gray color).