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:APIClass|WeibullEvents Class|WeibullEvents}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
-Display a message.
-== Weibull Declaration  ==
+<onlyinclude>Occurs when an error is produced. Displays an error message.</onlyinclude>
-{{APIPrefix|Public Overridable Sub}}
-{{APIName|Message(}}
-{{APIPrefix|ByVal}}
-{{APIName|sender}}
-{{APIPrefix|As}}
-{{APIName|[[WeibullDataSet Class|WeibullDataSet]],}}
-{{APIPrefix|ByVal}}
-{{APIName|sMsg}}
-{{APIPrefix|As String}}
-{{APIName|,}}
-{{APIPrefix|ByVal}}
-{{APIName|AdditionalInfo}}
-{{APIPrefix|As String}}
-{{APIName|,}}
-{{APIPrefix|ByVal}}
-{{APIName|IsCritical}}
-{{APIPrefix|As Boolean}}
-{{APIName|)}}
-{{APIComment|Called by ‘sender’ when a message should be displayed.}}
+{{Template:API_EventsNote}}
-== Parameters ==
+== Syntax ==
-'''sender'''
+ '''_Message'''(''msg'', ''IsCritical'')
-An WeibullDataSet object
-'''sMsg'''
+===Parameters===
-The main display label.
+''msg''
+: Required. String. The message to display when an error occurs.
+''IsCritical''
+: Required. Boolean. Indicates whether the error is critical. Default value = False.
-'''AdditionalInfo'''
-The remaining label.
-'''IsCritical'''
+== Example ==
-(This might be used to indicate which icon to display.)
+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
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
+     {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
+   {{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({{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}}
-== Usage Example ==
+ '''VB.NET'''
-{{APIComment|Declare the WeibullEvents.}}<br>
+ {{APIComment|'Specify a variable to handle the event.}}
-{{APIComment|Declare the WeibullDataSet.}}<br>
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
-{{APIComment|Note: The WeibullDataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}
-        Dim WEvents as New WeibullEvents
+ {{APIComment|'----------------------------}}
-        Dim WDS as New WeibullDataSet
+  {{APIPrefix|Private Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
-{{APIComment|Show a prompt with the respective strings.}}
+     wds = {{APIPrefix|New}} WeibullDataSet
-        WEvents.Message(WDS, "Message1", "AdditionalInfo1", False)
+   {{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