WeibullDataSet.Message: Difference between revisions
Albert Szeto (talk | contribs) (moved WeibullEvents.Message to Message over redirect) |
Albert Szeto (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
Display a message. | |||
== Weibull Declaration == | |||
{{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.}} | |||
==ALTA Declaration== | |||
{{APIPrefix|Public Overridable Sub}} | |||
{{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|)}} | |||
{{APIComment|Called by ‘sender’ when a message should be displayed.}} | |||
== Parameters == | |||
'''sender''' | |||
An WeibullDataSet object | |||
'''sMsg''' | |||
The main display label. | |||
'''AdditionalInfo''' | |||
The remaining label. | |||
'''IsCritical''' | |||
(This might be used to indicate which icon to display.) | |||
== Usage Example == | |||
{{APIComment|Declare the WeibullEvents. Substitute [[ALTAEvents Class|ALTAEvents]] for ALTA.}}<br> | |||
{{APIComment|Declare the WeibullDataSet. Substitute [[ALTADataSet Class|ALTADataSet]] for ALTA.}}<br> | |||
{{APIComment|Note: The WeibullDataSet/ALTADataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}} | |||
Dim WEvents as New WeibullEvents | |||
Dim WDS as New WeibullDataSet | |||
{{APIComment|Show a prompt with the respective strings.}} | |||
WEvents.Message(WDS, "Message1", "AdditionalInfo1", False) | |||
Revision as of 21:49, 16 September 2013
Display a message.
Weibull Declaration
Public Overridable Sub Message( ByVal sender As WeibullDataSet, ByVal sMsg As String , ByVal AdditionalInfo As String , ByVal IsCritical As Boolean )
Called by ‘sender’ when a message should be displayed.
ALTA Declaration
Public Overridable Sub Message( ByVal sender As ALTADataSet, ByVal sMsg As String , ByVal AdditionalInfo As String , ByVal IsCritical As Boolean )
Called by ‘sender’ when a message should be displayed.
Parameters
sender An WeibullDataSet object
sMsg The main display label.
AdditionalInfo The remaining label.
IsCritical (This might be used to indicate which icon to display.)
Usage Example
Declare the WeibullEvents. Substitute ALTAEvents for ALTA.
Declare the WeibullDataSet. Substitute ALTADataSet for ALTA.
Note: The WeibullDataSet/ALTADataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.
Dim WEvents as New WeibullEvents
Dim WDS as New WeibullDataSet
Show a prompt with the respective strings.
WEvents.Message(WDS, "Message1", "AdditionalInfo1", False)