CxHmiCas3 Events

Scripting > CxHmiCas > CxHmiCas3 Object > CxHmiCas3 Events

CxHmiCas3 Events

The CxHmiCas3 object contains the following events:

AlarmDblClicked
AlarmRefreshRateChanged
AlarmSelected
ContextMenu
FilterChange
OnButtonClick

OnSecondButtonClick
OnTab
RefreshComplete
ServiceStatusChange
ViewableAlarmsChange

AlarmDblClicked

EventAlarmDblClicked is fired when an alarm is double-clicked.

Syntax

CxHmiCas3Object_EventAlarmDblClicked(Row As Long, Tag As String)

Parameters

Parameter	Description
Row	Returns the row that was double-clicked.
Tag	The tag of the double-clicked alarm, in SITE.SERVICE.POINTID:LONGPOINTID:FACILITY.UDC format.

Example

Sub CasCtrl_EventAlarmDblClicked(iRow, Tag)

Dim This : Set This = CasCtrl

'Code

End Sub

Note: You can retrieve the alarm in FullTag format using the GetTagForRow method.

AlarmRefreshRateChanged

EventAlarmRefreshRateChanged is fired when the refresh rate of the shared alarm cache is changed.

Syntax

CxHmiCas3Object_EventAlarmRefreshRateChanged(NewRefreshRate As Long)

Parameters

Parameter	Description
NewRefreshRate	The new refresh rate of the shared alarm cache.

Remark

The refresh rate of the shared alarm cache can be changed with the RequestAlarmRefreshRateChange method.

Example

Sub CasCtrl_EventAlarmRefreshRateChanged(NewRefreshRate)

Dim This : Set This = CasCtrl

'Code

End Sub

AlarmSelected

EventAlarmSelected is fired when an alarm is selected.

Syntax

CxHmiCas3Object_EventAlarmSelected(Row As Long, Tag As String)

Parameters

Parameter	Description
Row	Returns the row that was selected.
Tag	The tag of the selected alarm, in SITE.SERVICE.POINTID:LONGPOINTID:FACILITY.UDC format.

Example

Sub CasCtrl_EventAlarmSelected(iRow, Tag)

Dim This : Set This = CasCtrl

'Code

End Sub

Note: You can retrieve the alarm in FullTag format using the GetTagForRow method.

ContextMenu

This event is fired when a custom context menu item is selected.

Syntax

CxHmiCas3Object_EventContextMenu(Col As Long, Row As Long, EventID As String)

Parameters

Parameter	Description
Col	The column number of the cell that was right-clicked.
Row	The row number of the cell that was right-clicked.
EventID	The ID of the selected custom context menu item.

Example

Sub CasCtrl_EventContextMenu(Col, Row, EventID)

Dim This : Set This = CasCtrl

'Code

End Sub

Note: You can retrieve the alarm in FullTag format using the GetTagForRow method.

FilterChange

EventFilterChange is fired when the filter is changed.

Syntax

CxHmiCas3Object_EventFilterChange()

Example

Sub CasCtrl_EventFilterChange()

Dim This : Set This = CasCtrl

'Code

End Sub

OnButtonClick

EventOnButtonCLick is fired when a button in the first button column is pressed, if the button is configured to do so, and if the event is scripted to do so. See Button First Column for more information.

Syntax

CxHmiCas3Object_EventOnButtonClick(Row As Long, Tag As String)

Parameters

Parameter	Description
Row	The row that was clicked.
Tag	The point tag of the row that was clicked, in SITE.SERVICE.POINTID:LONGPOINTID:FACILITY.UDC format.

Example

Sub CasCtrl_EventOnButtonClick(iRow, Tag)

Dim This : Set This = CasCtrl

'Code

End Sub

Note: You can retrieve the alarm in FullTag format using the GetTagForRow method.

OnSecondButtonClick

EventOnSecondButtonClick is fired when a button in the last button column is pressed, if the button is configured to do so, and if the event is scripted to do so. See Button Last Column for more information.

Syntax

CxHmiCas3Object_EventOnSecondButtonClick(Row As Long, Tag As String)

Parameters

Parameter	Description
Row	The row that was clicked.
Tag	The point tag of the row that was clicked, in SITE.SERVICE.POINTID:LONGPOINTID:FACILITY.UDC form.

Example

Sub CasCtrl_EventOnSecondButtonClick(iRow, Tag)

Dim This : Set This = CasCtrl

'Code

End Sub

Note: You can retrieve the alarm in FullTag format using the GetTagForRow method.

OnTab

EventOnTab is fired when the tab key is pressed.

Syntax

CxHmiCas3Object_EventOnTab()

Example

Sub CasCtrl_EventOnTab()

Dim This : Set This = CasCtrl

'Code

End Sub

RefreshComplete

Fired when a full refresh has completed.

Syntax

CxHmiCas3Object_EventRefreshComplete()

Example

Sub CasCtrl_EventRefreshComplete()

Dim This : Set This = CasCtrl

'Code

End Sub

ServiceStatusChange

EventServiceStatusChange is fired when the service status changes.

Syntax

CxHmiCas3Object_EventServiceStatusChange(Service As String, Status As String, NumStoppedServices As Long)

Parameters

Parameter	Description
Service	The service that has changed in status.
Status	The new status of the service.
NumStoppedServices	The number of connected services (i.e. the services listed in the SiteServices property) that are stopped.

Example

Sub CasCtrl_EventServiceStatusChange(Service, Status, NumStoppedServices)

Dim This : Set This = CasCtrl

'Code

End Sub

ViewableAlarmsChange

EventViewableAlarmsChange is fired when there is a change in the viewable alarms.

Syntax

CxHmiCas3_EventViewableAlarmsChange(AlarmsAdded As Long, AlarmsChanged As Long, AlarmsRemoved As Long)

Parameters

Parameter	Description
AlarmsAdded	The number of newly-added alarms.
AlarmsChanged	The number of changed alarms.
AlarmsRemoved	The number of removed alarms.

Example

Sub CasCtrl_EventViewableAlarmsChange(AlarmsAdded, AlarmsChanged, AlarmsRemoved)

Dim This: Set This = CasCtrl

'Code

End Sub