ALTADataSet.Message: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|ALTAEvents Class|ALTAEvents}}
{{Template:API}}{{Template:APIBreadcrumb|.[[ALTADataSet Class|ALTADataSet]]}}


Display a message.


== Method Syntax ==
<onlyinclude>Occurs when an error is produced. Displays an error message.</onlyinclude>
{{APIName|'''Message'''(}}
{{APIPrefix|ByVal}}
{{APIName|sender}}
{{APIPrefix|As}}
{{APIName|[[ALTADataSet Class|ALTADataSet]],}}
{{APIPrefix|ByVal}}
{{APIName|sMsg}}
{{APIPrefix|As String}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|AdditionalInfo}}
{{APIPrefix|As String}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|IsCritical}}
{{APIPrefix|As Boolean}}
{{APIName|)}}<br>
{{APIComment|Called by ‘sender’ when a message should be displayed.}}


== Parameters ==
'''sender'''
An ALTADataSet object


'''sMsg'''
{{Template:API_EventsNote}}
The main display label.


'''AdditionalInfo'''
== Syntax ==
The remaining label.
'''_Message'''(''msg'', ''IsCritical'')


'''IsCritical'''
===Parameters===
(This might be used to indicate which icon to display.)
''msg''
: Required. String. The message to display when an error occurs.
''IsCritical''
: Required. Boolean. Indicates whether the error is critical. Default value = False.


== Usage Example ==


{{APIComment|Declare the ALTAEvents.}}<br>
== Example ==
{{APIComment|Declare the ALTADataSet.}}<br>
The following example provides a simple demonstration on how to customize the event procedure.
{{APIComment|Note: The ALTADataSet constructor already creates a new ALTAEvents, which could be used in place of AEvents in the example below.}}
'''VBA'''
        Dim AEvents as New ALTAEvents
 
        Dim ADS as New ALTADataSet
{{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}}


{{APIComment|Show a prompt with the respective strings.}}
'''VB.NET'''
        AEvents.Message(ADS, "Message1", "AdditionalInfo1", False)
{{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}}

Latest revision as of 23:43, 6 September 2016

APIWiki.png


Member of: SynthesisAPI.ALTADataSet


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