_Ui

Internal data point for the user interface. Contains all information of panels, layers etc. There is one data point per user interface. The _Ui data point is read-only for all users. The UI manager can only write to the local _Ui data point. _Ui data points contain the _auth config.

You must create data points with an _auth config for UIs that were started with a number higher than ten.

Data point element Type Description
LayerOn.ModuleName string Name of the module in which the level/layer is opened.
LayerOn.PanelName string Name of the panel in which the level/layer is opened.
LayerOn.Layer int Number of the level/layer that is opened.
LayerOff.ModuleName string Name of the module in which the level/layer is closed.
LayerOff.PanelName string Name of the panel in which the level/layer is closed.
LayerOff.Layer int Number of the level/layer that is closed.
PanelOff.ModuleName string Name of the module in which the panel is closed.
PanelOff.PanelName string Name of the panel that is closed.
ConfirmAll.ModuleName string Name of the module in the mode acknowledge all.
ConfirmMode.ModuleName string Name of the module in the mode single acknowledgement.
ActivateMode.ModuleName string Name of the module in operating mode.
RootPanelOrigOn.ModuleName string Name of the module in which the root panel is opened.
RootPanelOrigOn.FileName string File name of the panel to be opened.
RootPanelOrigOn.PanelName string Name of the panel that is opened.
RootPanelOrigOn.Parameter dyn_string List of the $ parameters of the panel.
RootPanelOn.ModuleName string Description of the module in which a panel is opened.
RootPanelOn.FileName string File name of the panel that should be opened.
RootPanelOn.PanelName string Description of the panel that is opened.
RootPanelOn.Parameter dyn_string List of the $ parameters that are opened.
ChildPanelOn.ModuleName string Name of the module in which a child panel is opened.
ChildPanelOn.FileName string File name of the panel that is opened.
ChildPanelOn.ParentName string Name of the root panel in which a child panel is opened.
ChildPanelOn.PanelName string Name of the panel in which a child panel is opened.
ChildPanelOn.X int x position at which a child panel is opened.
ChildPanelOn.Y int y position at which a child panel is opened.
ChildPanelOn.Scale float Scale factor for child panels.
ChildPanelOn.ParentScale bool Root panel is also scaled when TRUE.
ChildPanelOn.Parameter dyn_string For the dollar parameters of the child panel.
ChildPanelOn.Modal bool When the element is True a child panel is opened modal.
ModuleOn.ModuleType int Type of the module that is opened.
ModuleOn.ModuleName string Name of the module that is opened.
ModuleOn.X int x position at which the module is opened.
ModuleOn.Y int y position at which the module is opened.
ModuleOn.W int Width of the opened module.
ModuleOn.H int Height of the opened module.
ModuleOn.IconBar unsigned Specifies how the icon bar is displayed. 0... default from resources, 1... without symbol bar, 2... with symbol bar.
ModuleIOn.MenuBar unsigned Specifies how the menu bar is displayed, 0... default from resources, 1...without menu bar, 2... with menu bar.
ModuleOn.MessageArea unsigned
ModuleOn.ResizeMode string ""... default from resources, "None"... No scaling in module VISION possible, "Scale"...Scaling in VISION module possible via changing the window size.
ModuleOff.ModuleName string Name of the module that is closed.
PrintPanel.ModuleName string Name of the module the panel is printed from.
PrintPanel.Script string
ReportInterpeter.FileName string
ReportInterpreter.Starttime time
ReportInterpreter.StopTime time
ReportInterpreter.PrintCF int
Zoom.ModuleName string Name of the module that is zoomed in.
Zoom.Factor string The zoom factor.
Zoom.X int x position of the window in module.
Zoom.Y int y position of the window in module.
Zoom.Set bool Activates the zoom in.
MouseClick.ModuleName string
MouseClick.PanelName string
MouseClick.X int MouseClick.X is the x position of the mouse click in the panel converted to the 100% scale factor of the panel.
MouseClick.Y int MouseClick.Y is the y position of the mouse click in the panel converted to the 100% scale factor of the panel.
MouseClick.XTranslate int MouseClick.XTranslate is the x position of the mouse click in the panel.
MouseClickYTranslate int MouseClick.YTranslate is the y position of the mouse click in the panel.
ReturnValue.Float dyn_float
ReturnValue.Text dyn_string
UserName string

User name.

After exiting the UI it will be set to "". After re-starting the UI the user will be logged in, who has been entered in the config file.
SilentPrint unsigned The status of the current or last print task. 1 successful processed, wait for new tasks, 2 user canceled, 3 wait (e.g. until all CTRL scripts were executed), error (e.g. the panel could not be read).
Print.PrinterName string

With the aid of this DP element the desired printer can be specified. If this entry is omitted the standard printer is used.

In the silent mode or without print dialog, the printout can be also saved in a local file. The supported formats are PDF (*.pdf) and Postscript (*.ps).

Syntax:

"file:///path/file.pdf";

Examples:

Linux: "file:///tmp/file.pdf";

Windows: "file:///C:/Temp/file.ps";
Print.Background bool According to the set value of this bit data point the set background color of the panel is printed or not. The value 1 means that the background is considered when printing. Inserted images as background are printed anyway independent from the chosen setting.
Print.Landscape bool If this element is set to value 1 the print is printed in "landscape" format otherwise "portrait".
Print.FitToPage bool Allows scaling independent from the printer.
Print.Scale float In this float element the desired scale factor is specified. The value 1 means 100% scaling. This means print on scale 1:1.
Para.OpenConfig string Name of the opened config with address.
Para.ModuleName string Name of the opened PARA module.
LatestPanels.FileNames dyn_string
LatetestPanels.FirstPanel string
LatestPanels.Parameters dyn_string
LatestPanels.PanelNames dyn_string
DpeInfo.CurrentDpe.Name string Node for DPEinfo panel. The name of the currently queried data point is saved here.
DpeInfo.CurrentDpe.Module string
DpeInfo.CurrentDpe.Panel string
DpeInfo.RecentDpe.LastDpes dyn_string List of the last queried data points.
Inactivity.Warning bool These elements are used for the settings of the inactivity management. Detailed information you will find in the chapter Inactivity management.
Inactivity.Commit bool
Inactivity.WarningTimeout int
Inactivity.CommitTimeout int
Inactivity.Action int
AutoLogoutTime int
ModuleGeometry.ModuleName string Name of the opened module.
ModuleGeometry.PanelName string Name of the panel opened in the module.
ModuleGeometry.X int Position of the module on the screen (X direction).
ModuleGeometry.Y int Position of the module on the screen (Y direction).
ModuleGeometry.Width int Width of the module.
ModuleGeometry.Height int Height of the module.
ModuleFocus.ModuleName string Name of the module that gets currently the focus. This data point element is read-only and by default disabled. With the config entry sendModuleFocusDp the sending of the name of the current module with focus can be enabled.
ModuleFocus.Geometry dyn_int Position and size of the module that currently gets the focus (posX, posY, width, heigth). posX and posY are the pixel coordinates of the module on the desktop. This data point element is read-only and by default disabled. With the config entry sendModuleFocusDp the sending of the name of the current module with focus can be enabled.
Navigation.ModuleName Name of the module that is being navigated (e.g. "mainModule_1").
Navigation.System Name of the system on that the navigation is processed (e.g. System1).
Navigation.TopoNode Node number of the panel that is displayed (e.g. StartPanel = 1). The mapping of number and panel can be indicated in the internal data point _PanelTopology.<System_Nr>_PanelTopology (internal data point elements panelNumber and nodeName).
DisplayName string

Contains the content of the "Display" environment variable.

Currently used for internal purposes only .