Difference between revisions of "ALTADataSet.UpdateCalculationProgress"

From ReliaWiki
Jump to navigation Jump to search
Line 37: Line 37:
  
 
== Usage Example ==
 
== Usage Example ==
 +
This example demonstrates how to produce a dialog box when a message should be displayed.
 
  {{APIComment|'Overrides requested. Create a new class, inherit WeibullEvents,}}
 
  {{APIComment|'Overrides requested. Create a new class, inherit WeibullEvents,}}
 
  {{APIComment|'and set the dataset's events.}}
 
  {{APIComment|'and set the dataset's events.}}

Revision as of 22:01, 5 May 2014


Called when the calculation progress should be updated. Provides ability to customize the calculation progress display.

Syntax

  • UpdateCalculationProgress( sender As ALTADataSet , msgx_0 As String, msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long, Cancel As Boolean )

Parameters

sender: An ALTADataSet object.
msgx_0: The main display label.
msgx_1: The remaining label.
pdone : The percentage to display, in decimal form (0.00 to 0.99).
append_to: If True, append pdone to the current percentage value in the progress display at the rate of Prev_increment, otherwise pdone will replace the value.
Prev_increment: This is the value of the incremental value per progress update if append_to is True. If append_to is False, this value is ignored.
Cancel: This determines if the calculation can be cancelled.

Usage Example

This example demonstrates how to produce a dialog box when a message should be displayed.

 'Overrides requested. Create a new class, inherit WeibullEvents, 
 'and set the dataset's events. 
 Private Class myEvents
     Inherits WeibullEvents
     Public Overrides Sub UpdateCalculationProgress(sender As ALTADataSet, msgx_0 As String, 
     msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long, 
     ByRef Cancel As Boolean)
         MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to, Prev_increment, Cancel)
          '<Additional overridden code here.> 
     End Sub
 End Class
 
 'Set the new Events class. 
 ADS.Events = New myEvents
 
 'Update calculation progress. 
 ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)
 
 'The "Cancel" checkbox reflects the value of wasCanceled