CxFmsPPACtrl Methods

The CxFmsPPACtrl object contains the following methods:

Apply

Applies modified settings and builds the FMS PPA control.  This method has the same function as the Apply button on the FMS Prior Period Adjustment control.

Syntax

Apply(SessionPropertiesOnly As Boolean)

Parameters

Parameter

Required

Description

SessionPropertiesOnly

No

If this parameter is set to 1 - Yes (True), only the properties SessionBeginDate and SessionEndDate will be applied.

Example

The following example applies settings when a button is pressed.

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

Back to top

Cancel

Cancels the current task. 

Syntax

Cancel()

Remarks

The following tasks can be canceled with this method.

Example

The following example cancels a task when a button is pressed.  This example is taken from FMS PPA Ctrl.csf found in the APPS SCREXAMP folder.

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

Back to top

Refresh

Refreshes the data in the FMS PPA control.  This method has the same function as the Refresh button on the FMS Prior Period Adjustment control.

Syntax

Refresh()

Example

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

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

Back to top