View source for Talk:ALTAEvents Class/Notes

=DRAFT=
{{Template:API}}{{Template:APIBreadcrumb}}

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

== Methods  ==
*[[ALTAEvents.Message|Message( ALTADataSet, String, String,  Boolean )]] {{APIComment|{{Template:WeibullEvents.Message.Cmt}}}} 
*[[ALTAEvents.Question|Question( ALTADataSet, String, MsgBoxStyle, MsgBoxResult )]] {{APIComment|{{Template:WeibullEvents.Question.Cmt}}}} 
*[[ALTAEvents.UpdateCalculationProgress|UpdateCalculationProgress( ALTADataSet, String, String, Double, Boolean, Long, Boolean ) ]]{{APIComment|{{Template:WeibullEvents.UpdateCalculationProgress.Cmt}}}} 
*[[ALTAEvents.ShowCalculationProgress|ShowCalculationProgress( ALTADataSet )]]{{APIComment|{{Template:WeibullEvents.ShowCalculationProgress.Cmt}}}} 
*[[ALTAEvents.HideCalculationProgress|HideCalculationProgress( ALTADataSet )]]{{APIComment|{{Template:WeibullEvents.HideCalculationProgress.Cmt}}}}

== Usage Example ==
This example demonstrates how to produce a dialog box when an answer to a question is required.
 {{APIComment|'Create a new ALTADataSet object.}}
  Dim ADS As New ALTADataSet
  
 {{APIComment|'Overrides requested. Create a new class, inherit ALTAEvents, and set the dataset's events.}}
  Private Class myEvents
      Inherits ALTAEvents
      Public Overrides Sub Question(sender As ALTADataSet, sMsg As String, Buttons As MsgBoxStyle, ByRef Answer As MsgBoxResult)
          MyBase.Question(sender, sMsg, Buttons, Answer)
             {{APIComment|'<Add additional code here.>}}
      End SubEnd Class
  
 {{APIComment|'Set the new Events class.}}
  ADS.Events = New myEvents
  
 {{APIComment|'Initialize the MsgBoxStyle and MsgBoxResult variables. Three buttons will be displayed.}}
  Dim Buttons As MsgBoxStyle = MsgBoxStyle.YesNoCancel
  Dim Answer As MsgBoxResult 
  
 {{APIComment|'Ask a question. Result will be updated in Answer.}}
  ADS.Events.Question(ADS, "Continue?", Buttons, Answer)