Talk:WeibullEvents Class/Notes

DRAFT

Member of: SynthesisAPI

Contains all the event handlers that can be called by WeibullDataSet. To use events, you must inherit the class, override its methods and assign its instance to the Events property of a WeibullDataSet. WeibullEvents inheritance is not available in VB6/VBA.

Methods

• Message( WeibullDataSet, String, String, Boolean ) Called when a message should be displayed. Displays a message.
• Question( WeibullDataSet, String, MsgBoxStyle, MsgBoxResult ) Called when an answer to a question is required. Displays a prompt and returns the result.
• GetDistrParameters( WeibullDataSet, String, Boolean, List( Of ParamInputInfo ), Boolean ) Called when additional input is required.
• UpdateCalculationProgress( WeibullDataSet, String, String, Double, Boolean, Long, Boolean ) Called when the calculation progress should be updated. Provides ability to customize the calculation progress display.
• ShowCalculationProgress( WeibullDataSet ) Called when calculation progress should be shown. Shows the current calculation progress if the calculation process is running.
• HideCalculationProgress( WeibullDataSet ) Called when calculation progress should be hidden. Hides the calculation progress display.

Usage Example

 'Overrides requested. Create a new class and inherit WeibullEvents. Then set the dataset's events. 
 Private Class myEvents
     Inherits WeibullEvents
         Public Overrides Sub Message(sender As WeibullDataSet, sMsg As String, 
         AdditionalInfo As String, IsCritical As Boolean)
             MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
                 '<Add additional code here.> 
         End Sub
 End Class
 
 'Declare a new WeibullDataSet. 
 Dim WDS as New WeibullDataSet
 
 'Use the created myEvents class in place of the one created by the dataset. 
 WDS.Events = New myEvents
 
 'Show a prompt with the respective strings. The additional code will also run. 
 WDS.Events.Message(WDS, "Message1", "AdditionalInfo1", False)