CxFmsBalanceCtrl Events

The CxFmsBalanceCtrl object contains the following events.

EndRefresh

A refresh operation has completed.

Syntax

CxFmsBalanceCtrlObject_EventEndRefresh(Result As Integer, Status As Integer)

Parameters

Parameter Required Description

Result

Yes

An integer specifying whether the refresh succeeded or failed. Possible values for this property are as follows.

  • 0 — Success
  • 1 — Failure

Status

Yes

An integer specifying whether or not the refresh was canceled. Possible values for this property are as follows.

  • 0 — Not canceled
  • 1 — Canceled

Example

The following example displays a message box if the refresh was canceled.

Copy
EndRefresh
Sub FmsBalance_EventEndRefresh(Result, Status)
Dim This : Set This = FmsBalance
    If Status = 1 Then
        MsgBox "Refresh canceled"
    End If
End Sub

Back to top

GridFinished

A grid drawing operation has completed.

The Balance control data grid is built in dual stages (when requested data is first loaded and when a data row is first expanded with additional data, prompting a redraw). This event is raised after initial data loading [EventEndRefresh] and row expansion have both occurred, and indicates completion of the subsequent grid drawing operation.

Syntax

CxFmsBalanceCtrlObject_EventGridFinished()

Parameters

This event has no parameters.

Example

The following example displays a message box when the grid is finished.

Copy
GridFinshed
Sub FmsBalance_EventGridFinished()
Dim This : Set This = FmsBalance
    MsgBox "Grid finished"
End Sub

Back to top

Initialize

The control is initialized.

Syntax

CxFmsBalanceCtrlObject_EventInitialize()

Example

The following example displays a message box when the control is initialized.

Copy
Initialize
Sub FmsBalance_EventInitialize()
Dim This : Set This = FmsBalance
    MsgBox "Control initialized"
End Sub

Back to top

PumpData

(Obsolete)

Back to top

SetSessionNode

The Session Node has been set via the "Set as Session Node" context menu item (or via the Ctrl+Shift+S keyboard shortcut).

Syntax

CxFmsBalanceCtrlObject_EventSetSessionNode(NodeId As Integer)

Parameters

Parameter Required Description

NodeId

Yes

The ID of the Node that was set as the Session Node.

Example

The following example displays a message box when the Session Node is set.

Copy
name
Sub FmsBalance_EventSetSessionNode(NodeId)
Dim This : Set This = FmsBalance
    MsgBox CStr(NodeId)
End Sub

Back to top