WeibullDataSet.Message: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Member of: SynthesisAPI.WeibullDataSet

Occurs when an error is produced. Displays an error message.

Remarks: To hide the messages or write your own code for the event procedure, set the UseEvents property of the object to True. The event is raised by the class methods.

Syntax

_Message(msg, IsCritical)

Parameters

msg

Required. String. The message to display when an error occurs.

IsCritical

Required. Boolean. Indicates whether the error is critical. Default value = False.

Example

The following example provides a simple demonstration on how to customize the event procedure.

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

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

   'Set the application to use your event procedure. 
    wds.UseEvents = True

   'To trigger 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

VB.NET

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

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

   'Set the application to use your event procedure. 
    wds.UseEvents = True

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

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

@@ Line 1: / Line 1: @@
 {{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
-{{Template:InProgress}}
-<onlyinclude>Occurs when there is a calculation error.</onlyinclude>
+<onlyinclude>Occurs when an error is produced. Displays an error message.</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).
+{{Template:API_EventsNote}}
 == Syntax ==
-  '''_Message'''({{APIPrefix|ByVal}} ''msg'' {{APIPrefix|As String}}, {{APIPrefix|ByVal}} ''IsCritical'' {{APIPrefix|As Boolean}})
+  '''_Message'''(''msg'', ''IsCritical'')
 ===Parameters===
 ''msg''
-: The message to display.
+: Required. String. The message to display when an error occurs.
 ''IsCritical''
-: Indicates whether the message displayed is critical.
+: Required. Boolean. Indicates whether the error is critical. Default value = False.
 == Example ==
-The following example provides a simple demonstration on how to handle a custom event.
+The following example provides a simple demonstration on how to customize the event procedure.
   '''VBA'''
   {{APIComment|'Specify a variable to handle the event.}}
     {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
-   {{APIPrefix|Sub}} Main()
+ {{APIComment|'----------------------------}}
+   {{APIPrefix|Private Sub}} Main()
     {{APIComment|'Associate the event variable with an object.}}
       {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
-    {{APIComment|'Set the application to handle custom events.}}
+    {{APIComment|'Set the application to use your event procedure.}}
       wds.UseEvents = True
-    {{APIComment|'To raise the event, call the Calculate method without defining a data set. }}
+    {{APIComment|'To trigger the event, call the Calculate method without defining a data set. }}
       wds.Calculate
-    Msgbox({{APIString|"End"}})
+     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}}
+ '''VB.NET'''
+ {{APIComment|'Specify a variable to handle the event.}}
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
   {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
+     wds = {{APIPrefix|New}} WeibullDataSet
-   {{APIPrefix|Private Sub}} wds_Message({{APIPrefix|ByVal}} msg {{APIPrefix|As String}}, {{APIPrefix|ByVal}} IsCritical {{APIPrefix|As Boolean}})
+   {{APIComment|'Set the application to use your event procedure.}}
+     wds.UseEvents = True
+   {{APIComment|'To trigger 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(msg {{APIPrefix|As String}}, IsCritical {{APIPrefix|As Boolean}}) {{APIPrefix|Handles}} wds.Message
     {{APIComment|'<Add code here to handle the event.>}}
       MsgBox (msg)
    {{APIPrefix|End Sub}}

WeibullDataSet.Message: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search