WeibullDataSet.Message: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullEvents Class|WeibullEvents]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
{{Template:InProgress}}
{{Template:InProgress}}
<onlyinclude>Occurs when there is a calculation error.</onlyinclude>
'''Remarks''': Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. The event can be raised by the [[WeibullDataSet.Calculate|Calculate]] or [[WeibullDataSet.CalculateBestFit|CalculateBestFit]] method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times).
== Syntax ==
'''_Message'''({{APIPrefix|ByVal}} ''msg'' {{APIPrefix|As String}}, {{APIPrefix|ByVal}} ''IsCritical'' {{APIPrefix|As Boolean}})
===Parameters===
''msg''
: The message to display.
''IsCritical''
: Indicates whether the message displayed is critical.
== Example ==
The following example provides a simple demonstration on how to handle a custom event.
'''VBA'''
{{APIComment|'Specify a variable to handle the event.}}
  {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
  {{APIPrefix|Sub}} Main()
  {{APIComment|'Associate the event variable with an object.}}
    {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
  {{APIComment|'Set the application to handle custom events.}}
    wds.UseEvents = True
  {{APIComment|'To raise the event, call the Calculate method without defining a data set. }}
    wds.Calculate
    Msgbox({{APIString|"End"}})
  {{APIPrefix|End Sub}}
{{APIComment|'----------------------------}}
  {{APIPrefix|Private Sub}} wds_Message({{APIPrefix|ByVal}} msg {{APIPrefix|As String}}, {{APIPrefix|ByVal}} IsCritical {{APIPrefix|As Boolean}})
  {{APIComment|'<Add code here to handle the event.>}}
    MsgBox (msg)
  {{APIPrefix|End Sub}}

Revision as of 23:34, 11 August 2016

APIWiki.png


Member of: SynthesisAPI.WeibullDataSet Template:InProgress


Occurs when there is a calculation error.


Remarks: Instead of using the default event procedure, you can execute a custom procedure by setting the UseEvents property of the object to true. The event can be raised by the Calculate or CalculateBestFit method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times).

Syntax

_Message(ByVal msg As String, ByVal IsCritical As Boolean)

Parameters

msg

The message to display.

IsCritical

Indicates whether the message displayed is critical.


Example

The following example provides a simple demonstration on how to handle a custom event.

VBA

 'Specify a variable to handle the event. 
  Private WithEvents wds As WeibullDataSet

 Sub Main()
   'Associate the event variable with an object. 
    Set wds = New WeibullDataSet

   'Set the application to handle custom events. 
    wds.UseEvents = True

   'To raise the event, call the Calculate method without defining a data set.  
    wds.Calculate
   Msgbox("End")
 End Sub
 '---------------------------- 

 Private Sub wds_Message(ByVal msg As String, ByVal IsCritical As Boolean)
   '<Add code here to handle the event.> 
    MsgBox (msg)
 End Sub