CxFmsHistoryGridCtrl Events

Scripting > CxHmiFms > CxFmsHistoryGridCtrl Object > CxFmsHistoryGridCtrl Events

CxFmsHistoryGridCtrl Events

The CxFmsHistoryGridCtrl object contains the following events.

BeginSave
EditModeChange
EndRefresh
EndSave
Initialize
PumpData

BeginSave

Click the Save button or call the Save method.

Syntax

CxFmsHistoryGridCtrlObject_EventBeginSave()

Example

The following example disables the Save button when a save starts.

Sub FmsHistoryGrid_EventBeginSave()

Dim This : Set This = FmsHistoryGrid

btnSave.Enable False

End Sub

EditModeChange

Begin or finish editing data.

Syntax

CxFmsHistoryGridCtrlObject_EventEditModeChange()

Remarks

This event will be fired if one of the following conditions is met.

The user begins editing data for the first time
The user begins editing data after the Save button has been pressed or the Save method has been called
The user clicks the Save button or calls the Save method after editing data

Example

The following example displays a message box when the Edit mode changes.

Sub FmsHistoryGrid_EventEditModeChange()

Dim This : Set This = FmsHistoryGrid

MsgBox "Edit mode changed"

End Sub

EndRefresh

A refresh operation has completed.

Syntax

CxFmsHistoryGridCtrlObject_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

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.

Sub FmsHistoryGrid_EventEndRefresh(Result, Status)

Dim This : Set This = FmsHistoryGrid

If Status = 1 Then

MsgBox "Refresh canceled"

End If

End Sub

EndSave

A save operation has completed.

Syntax

CxFmsHistoryGridCtrlObject_EventEndSave(Result As Integer, Status As Integer)

Parameters

Parameter	Required	Description
Result	Yes	An integer specifying whether the save succeeded or failed. Possible values for this property are as follows. 0 – Success 1 - Failure
Status	Yes	An integer specifying whether or not the save was canceled. Possible values for this property are as follows. 0 – Not canceled 1 - Canceled

Parameter

Required

Description

Result

Yes

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

0 – Success
1 - Failure

Status

Yes

An integer specifying whether or not the save 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 save was canceled, and enables the Save button.

Sub FmsHistoryGrid_EventEndSave(Result, Status)

Dim This : Set This = FmsHistoryGrid

If Status = 1 Then

MsgBox "Save canceled"

End If

btnSave.Enable True

End Sub

Initialize

The control is initialized.

Syntax

CxFmsHistoryGridCtrlObject_EventInitialize()

Example

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

Sub FmsHistoryGrid_EventInitialize()

Dim This : Set This = FmsHistoryGrid

MsgBox "Control initialized"

End Sub

PumpData

(Obsolete)