CxFmsAlarmLogCtrl Methods

The CxFmsAlarmLogCtrl object contains the following methods:

Apply Cancel ChooserGetNodeSelection ChooserSetNodeSelection Refresh RetrieveNodes

Apply

Applies modified settings and builds the FMS Alarm control.  This method has the same function as the Apply button on the FMS Alarm control.

Syntax

Apply(SessionPropertiesOnly As Boolean)

Parameters

Parameter	Required	Description
SessionPropertiesOnly	No	If this parameter is set to 1 - Yes (True), only the properties SessionNodeTag, SessionBeginDate, and SessionEndDate will be applied.

Example

The following example applies settings when a button is pressed.

  

Sub ButtonTool_EventClick() Dim This : Set This = ButtonTool FmsAlarm.Apply End Sub

Cancel

Cancels the current task. 

Syntax

Cancel()

Remarks

The following is the list of tasks that can be canceled with this method.

• Building or refreshing the FMS Alarm control
• Retrieving the Node state records
• Saving edited alarm records

Example

The following example cancels a task when a button is pressed.  This example is taken from FMS Alarm Ctrl.csf.

  

Sub btnCancel_EventClick() Dim This : Set This = btnCancel FmsAlarm.Cancel End Sub

ChooserGetNodeSelection

Returns the list of Nodes currently selected in the Node chooser.

Syntax

ChooserGetNodeSelection() As Variant

Example

The following example displays a message box showing the list of selected Nodes.

  

Sub ButtonTool1_EventClick() Dim This : Set This = ButtonTool1 Dim aryNodes aryNodes = FmsAlarm.ChooserGetNodeSelection   Dim i, strMsg For i = 0 To UBound(aryNodes) strMsg = strMsg & aryNodes(i) & Vbcr Next   MsgBox strMsg End Sub

ChooserSetNodeSelection

Sets the selection of Nodes in the Node chooser.

Syntax

ChooserSetNodeSelection(Selections As Variant) As Boolean

Parameters

Parameter	Required	Description
Selections	Yes	The Node, in "Node ID" format, to select in the Node chooser.

Example

The following example selects a Node in the Node chooser.

Sub ButtonTool1_EventClick() Dim This : Set This = ButtonTool1 Dim aryNodes Redim aryNodes(0)   aryNodes(0) = "2540"   FmsAlarm.ChooserSetNodeSelection aryNodes End Sub

Refresh

Refreshes the data in the FMS Alarm control. This method has the same function as the Refresh button on the FMS Alarm control.

Syntax

Refresh()

Example

The following example refreshes the FMS Alarm control when a button is pressed.

Sub ButtonTool1_EventClick() Dim This : Set This = ButtonTool1 FmsAlarm.Refresh End Sub

RetrieveNodes

Populates the Node chooser’s list of Nodes. This method has the same function as the Retrieve Nodes button on the FMS Alarm control’s Node chooser.

Syntax

RetrieveNodes()

Remarks

When this method is called, the Node chooser is populated according to the ChooserSiteServiceSelection, ChooserGroupSelection, ChooserFilterString, and ChooserFilterType properties.

Example

The following example retrieves Nodes when the View is initialized.

Sub TheView_EventInitialize() Dim This : Set This = TheView FmsAlarm.RetrieveNodes End Sub