ALTADataSet.Message: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) m (moved ALTAEvents.Message to ALTADataSet.Message: Change in API structure) |
Kate Racaza (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|.[[ | {{Template:API}}{{Template:APIBreadcrumb|.[[ALTADataSet Class|ALTADataSet]]}} | ||
{{Template:InProgress}} | {{Template:InProgress}} | ||
<onlyinclude>Occurs when an error is produced. Displays an error message.</onlyinclude> | |||
{{Template:API_EventsNote}} | |||
== 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''' | |||
{{APIComment|'Specify a variable to handle the event.}} | |||
{{APIPrefix|Public WithEvents}} ads {{APIPrefix|As}} ALTADataSet | |||
{{APIComment|'----------------------------}} | |||
{{APIPrefix|Public Sub}} Main() | |||
{{APIComment|'Associate the event variable with an object.}} | |||
{{APIPrefix|Set}} ads = {{APIPrefix|New}} ALTADataSet | |||
{{APIComment|'Set the application to use your event procedure.}} | |||
ads.UseEvents = True | |||
{{APIComment|'Trigger the event by calling the Calculate method without defining a data set. }} | |||
ads.Calculate | |||
Msgbox({{APIString|"End"}}) | |||
{{APIPrefix|End Sub}} | |||
{{APIComment|'----------------------------}} | |||
{{APIPrefix|Private Sub}} ads_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|Public WithEvents}} ads {{APIPrefix|As}} ALTADataSet | |||
{{APIComment|'----------------------------}} | |||
{{APIPrefix|Sub}} Main() | |||
{{APIComment|'Associate the event variable with an object.}} | |||
ads = {{APIPrefix|New}} ALTADataSet | |||
{{APIComment|'Set the application to use your event procedure.}} | |||
ads.UseEvents = True | |||
{{APIComment|'Trigger the event by calling the Calculate method without defining a data set. }} | |||
ads.Calculate | |||
Msgbox({{APIString|"End"}}) | |||
{{APIPrefix|End Sub}} | |||
{{APIComment|'----------------------------}} | |||
{{APIPrefix|Private Sub}} ads_Message(msg {{APIPrefix|As String}}, IsCritical {{APIPrefix|As Boolean}}) {{APIPrefix|Handles}} ads.Message | |||
{{APIComment|'<Add code here to handle the event.>}} | |||
MsgBox (msg) | |||
{{APIPrefix|End Sub}} |
Revision as of 23:35, 16 August 2016
Member of: SynthesisAPI.ALTADataSet
Template:InProgress
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. Public WithEvents ads As ALTADataSet '---------------------------- Public Sub Main() 'Associate the event variable with an object. Set ads = New ALTADataSet 'Set the application to use your event procedure. ads.UseEvents = True 'Trigger the event by calling the Calculate method without defining a data set. ads.Calculate Msgbox("End") End Sub '---------------------------- Private Sub ads_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. Public WithEvents ads As ALTADataSet '---------------------------- Sub Main() 'Associate the event variable with an object. ads = New ALTADataSet 'Set the application to use your event procedure. ads.UseEvents = True 'Trigger the event by calling the Calculate method without defining a data set. ads.Calculate Msgbox("End") End Sub '---------------------------- Private Sub ads_Message(msg As String, IsCritical As Boolean) Handles ads.Message '<Add code here to handle the event.> MsgBox (msg) End Sub