ALTADataSet.Message: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|ALTAEvents Class|ALTAEvents}}
{{Template:APIClass|ALTAEvents Class|ALTAEvents}}
{{Template:ALTAEvents.Message.Cmt}}
{{Template:ALTAEvents.Message.Cmt}}


== Method Syntax ==
== Syntax ==
{{APIName|'''Message'''(}}
<ul><li>Message(
{{APIPrefix|ByVal}}
{{APIName|sender}}
{{APIName|sender}}
{{APIPrefix|As}}
{{APIPrefix|As}}
{{APIName|[[ALTADataSet Class|ALTADataSet]],}}
{{APIName|[[WeibullDataSet Class|WeibullDataSet]],}}
{{APIPrefix|ByVal}}
{{APIName|sMsg}}
{{APIName|sMsg}}
{{APIPrefix|As String}}
{{APIPrefix|As String}}
{{APIName|,}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|AdditionalInfo}}
{{APIName|AdditionalInfo}}
{{APIPrefix|As String}}
{{APIPrefix|As String}}
{{APIName|,}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|IsCritical}}
{{APIName|IsCritical}}
{{APIPrefix|As Boolean}}
{{APIPrefix|As Boolean}}
{{APIName|)}}<br>
{{APIName|)}}</li></ul>


== Parameters ==
Parameters
'''sender'''
:''sender'': An WeibullDataSet object
An ALTADataSet object.


'''sMsg'''
:''sMsg'': The main display label.
The main display label.


'''AdditionalInfo'''
:''AdditionalInfo'': The remaining label.
The remaining label.


'''IsCritical'''
:''IsCritical'': Indicates whether the message displayed is critical.
(This might be used to indicate which icon to display.)


== Usage Example ==
== Usage Example ==

Revision as of 20:58, 26 February 2014


Called by an ALTADataSet object when a message should be displayed. This displays a message.

Syntax

  • Message( sender As WeibullDataSet, sMsg As String , AdditionalInfo As String , IsCritical As Boolean )

Parameters

sender: An WeibullDataSet object
sMsg: The main display label.
AdditionalInfo: The remaining label.
IsCritical: Indicates whether the message displayed is critical.

Usage Example

Declare the ALTAEvents.
Declare the ALTADataSet.
Note: The ALTADataSet constructor already creates a new ALTAEvents, which could be used in place of AEvents in the example below.

       Dim AEvents as New ALTAEvents
       Dim ADS as New ALTADataSet

Show a prompt with the respective strings.

       AEvents.Message(ADS, "Message1", "AdditionalInfo1", False)