Promotic

Object PmgAlarmStateViewer

Description:
This object serves for viewing the alarm states of the PmaAlarmGroup object.
This object inherits properties, methods and events of the PmgObject object.
Properties and methods of this object:
Acknowledge()Acknowledgment of one selected item or all displayed items
GetColInfo()Returns information regarding the properties of viewer columns
GetDataFilter()Returns single or all values of the filtering string
GetDataItem()Returns the PmMap object containing the items of the selected row
GetGroupInfo()Returns information regarding PmaAlarmGroup
GetStateColor()Returns the color of the required alarm state
GetTimeFormat()Returns the formatting rule for defined column with time
SetDataFilter()Sets single or all values of the filtering string
SetStateColor()Sets the color of the alarm state
SetTimeFormat()Sets the formatting rule for defined column with time
SortColIdentifier of the column that is used to sort by
SortTypeSorting direction
Properties and methods inherited from the PmgObject object:
AddEvent()Registers a function into the specified event
Blink()Starts/stops blinking of the Pmg object
DxWidth of the Pmg object
DyHeight of the Pmg object
EnabledEnable/disable the control, i.e. user's inputs to the object
FocusDetects/set the focus of the Pmg object
GetChildByIndex()Returns the nested Pmg object defined by order
GetChildCount()Returns the number of nested Pmg objects
GetPathName()Object name with the path to this object
GetItemInfo()Returns special information regarding the Pmg object
GetPar()Reading the value of the Pmg object parameter (or its parents)
IniDxInitial width of the Pmg object
IniDyInitial height of the Pmg object
IniXInitial X-position of the left upper corner of the Pmg object relative to superior object
IniYInitial Y-position of the left upper corner of the Pmg object relative to superior object
Items()Returns reference to Pmg object
MethodsAccess to designer's methods of this object
MouseOnIdentification if the mouse cursor finds itself over the Pmg object
NameThe name of the Pmg object
ParentReturns reference to the parent Pmg object
Pm()Returns the Pma object (obsolete)
PmPanelReturns reference to the PmaPanel object where the Pmg object is placed
Refresh()Refresh of the Pmg object
RemoveEvent()Unregisters the function in the specified event
RootReturns reference to the root PmgRoot object
ShowMenu()Opens local menu of the Pmg object
ScreenXX-coordinate of the left upper corner of the Pmg object relative to computer screen
ScreenYY-coordinate of the left upper corner of the Pmg object relative to computer screen
ToolTipTooltip text of the Pmg object
Vars()Returns the variable of the Pmg object
ViewXPosition of X-coordinate of the left upper corner of the Pmg object relative to the PmgRoot object
ViewYPosition of the Y-coordinate of the left upper corner of the Pmg object relative to the PmgRoot object
VisibleSets the visibility/invisibility of the Pmg object
XX-coordinate of the left upper corner of the Pmg object relative to superior Pmg object
YY-coordinate of the left upper corner of the Pmg object relative to superior Pmg object
Events of this object:
onConnectIs triggered after connecting to alarm group
onActionIs triggered by clicking the mouse or by pressing the space key and is used to call the Acknowledge method
Events inherited from the PmgObject object:
onStartIs triggered on the construction of the Pmg object in the course of opening the panel
onStopIs triggered on the destruction of the Pmg object in the course of closing the panel
onRefreshIs triggered on the data refresh of the Pmg object
onMenuFillIs triggered after pressing by the right mouse button over the Pmg object
onMenuSelectIs triggered on the selection of the item from the Pmg object local menu
onModeChangeIs triggered when the Pmg object mode changes
onFocusInIs triggered if the object receives focus
onFocusOutIs triggered if the object loses focus
Configuration tabs:
ObjectGeneral information about the object
PositionSetting the position, width and height of the Pmg object
VariablesList and configuration of user defined Pmg object variables
EventsAlgorithms definition for the object events
MethodsDefinition of designer's method of the Pmg object
AppearanceSetting appearance of individual sections of the alarm state viewer
ViewerBasic parameters of the alarm state viewer
AppearanceSetting appearance of individual sections of the alarm state viewer
See also:

History:
Pm9.00.15: Fixed bug: Incorrect background color setting
Pm9.00.14: Modified preconfiguration controls, added context menu and new function for printing. New onConnect event.
Pm9.00.00: Created
PROMOTIC 9.0.27 SCADA system documentation MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r.o.