ALTADataSet.Message - Revision history

Kate Racaza at 23:43, 6 September 2016

2016-09-06T23:43:46Z

← Older revision		Revision as of 23:43, 6 September 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}
	~~{{Template:InProgress}}~~

Kate Racaza at 23:35, 16 August 2016

2016-08-16T23:35:19Z

← Older revision		Revision as of 23:35, 16 August 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[~~ALTAEvents~~ Class\|~~ALTAEvents~~]]}}		{{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}}

Kate Racaza: moved ALTAEvents.Message to ALTADataSet.Message: Change in API structure

2016-08-16T23:26:21Z

moved ALTAEvents.Message to ALTADataSet.Message: Change in API structure

← Older revision	Revision as of 23:26, 16 August 2016
(No difference)

Kate Racaza: Replaced content with '{{Template:API}}{{Template:APIBreadcrumb|.ALTAEvents}} {{Template:InProgress}}'

2016-05-06T15:37:49Z

Replaced content with '{{Template:API}}{{Template:APIBreadcrumb|.ALTAEvents}} {{Template:InProgress}}'

← Older revision		Revision as of 15:37, 6 May 2016
Line 1:		Line 1:
	{{Template:~~APIClass\|ALTAEvents Class\|ALTAEvents~~}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTAEvents Class\|ALTAEvents]]}}
	{{Template:~~WeibullEvents~~.~~Message.Cmt}}~~		{{Template:InProgress}}

	~~== Syntax ==~~
	~~<ul><li>Message(~~
	~~{{APIName\|sender}}~~
	~~{{APIPrefix\|As}}~~
	~~{{APIName\|~~[[~~ALTADataSet~~ Class\|~~ALTADataSet~~]],}}
	{{~~APIName\|sMsg}}~~
	~~{{APIPrefix\|As String}}~~
	~~{{APIName\|,}}~~
	~~{{APIName\|AdditionalInfo}}~~
	~~{{APIPrefix\|As String}}~~
	~~{{APIName\|,}}~~
	~~{{APIName\|IsCritical}}~~
	~~{{APIPrefix\|As Boolean}}~~
	~~{{APIName\|)}}</li></ul>~~

	~~Parameters~~
	:~~''sender'': An ALTADataSet object~~

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

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

	~~:''IsCritical'': Indicates whether the message displayed is critical.~~

	~~== Usage Example ==~~

	~~{{APIComment\|'Overrides requested, create a new class and Inherit WeibullEvents, and set the dataset's events.}~~}
	~~Private Class myEvents~~
	~~Inherits WeibullEvents~~
	~~Public Overrides Sub Message(sender As ALTADataSet, sMsg As String,~~
	~~AdditionalInfo As String, IsCritical As Boolean)~~
	~~MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)~~
	~~{{APIComment\|'<Add additional code here.>~~}}
	~~End Sub~~
	~~End Class~~

	~~{{APIComment\|'Set the new Events class.}}~~
	~~ADS.Events = New myEvents~~

	~~{{APIComment\|'Send a message.}}~~
	~~ADS.Events.Message(ADS, "message", "additional info", False)~~

Chris Kahn: /* Usage Example */

2014-05-06T16:45:11Z

Usage Example

← Older revision		Revision as of 16:45, 6 May 2014
Line 28:		Line 28:
	== Usage Example ==		== Usage Example ==

	{{APIComment\|'Overrides requested, ~~Create~~ a new class and Inherit WeibullEvents, and set the dataset's events.}}		{{APIComment\|'Overrides requested, create a new class and Inherit WeibullEvents, and set the dataset's events.}}
	Private Class myEvents		Private Class myEvents
	Inherits WeibullEvents		Inherits WeibullEvents

Chris Kahn: /* Usage Example */

2014-05-05T21:29:16Z

Usage Example

← Older revision		Revision as of 21:29, 5 May 2014
Line 34:		Line 34:
	AdditionalInfo As String, IsCritical As Boolean)		AdditionalInfo As String, IsCritical As Boolean)
	MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)		MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
	{{APIComment\|''<Add additional code here.>}}		{{APIComment\|'<Add additional code here.>}}
	End Sub		End Sub
	End Class		End Class

Chris Kahn: /* Usage Example */

2014-05-05T21:29:08Z

Usage Example

← Older revision		Revision as of 21:29, 5 May 2014
Line 34:		Line 34:
	AdditionalInfo As String, IsCritical As Boolean)		AdditionalInfo As String, IsCritical As Boolean)
	MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)		MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
	'<Add additional code here.>		{{APIComment\|''<Add additional code here.>}}
	End Sub		End Sub
	End Class		End Class

Chris Kahn: /* Usage Example */

2014-05-05T21:28:54Z

Usage Example

← Older revision		Revision as of 21:28, 5 May 2014
Line 32:		Line 32:
	Inherits WeibullEvents		Inherits WeibullEvents
	Public Overrides Sub Message(sender As ALTADataSet, sMsg As String,		Public Overrides Sub Message(sender As ALTADataSet, sMsg As String,
	AdditionalInfo As String, IsCritical As Boolean)		AdditionalInfo As String, IsCritical As Boolean)
	MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)		MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
	(Add additional code.)		'<Add additional code here.>
	End Sub		End Sub
	End Class		End Class

Chris Kahn: /* Usage Example */

2014-05-05T21:28:23Z

Usage Example

← Older revision		Revision as of 21:28, 5 May 2014
Line 31:		Line 31:
	Private Class myEvents		Private Class myEvents
	Inherits WeibullEvents		Inherits WeibullEvents
	Public Overrides Sub Message(sender As ALTADataSet, sMsg As String, AdditionalInfo As String, IsCritical As Boolean)		Public Overrides Sub Message(sender As ALTADataSet, sMsg As String,
			AdditionalInfo As String, IsCritical As Boolean)
	MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)		MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
	(Add additional code.)		(Add additional code.)

Chris Kahn: /* Usage Example */

2014-05-05T21:27:56Z

Usage Example

← Older revision		Revision as of 21:27, 5 May 2014
Line 28:		Line 28:
	== Usage Example ==		== Usage Example ==

	{{APIComment\|~~Declare~~ the ~~ALTAEvents~~.}}~~<br>~~		{{APIComment\|'Overrides requested, Create a new class and Inherit WeibullEvents, and set the dataset's events.}}
	~~{{APIComment\|Declare the~~ ALTADataSet.~~}}<br>~~		Private Class myEvents
	{{APIComment\|~~Note: The ALTADataSet constructor already creates a~~ new ~~ALTAEvents, which could be used in place of AEvents in the example below~~.}}		Inherits WeibullEvents
	~~Dim AEvents as New ALTAEvents~~		Public Overrides Sub Message(sender As ALTADataSet, sMsg As String, AdditionalInfo As String, IsCritical As Boolean)
	~~Dim~~ ADS as New ~~ALTADataSet~~		MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)
			(Add additional code.)
	{{APIComment\|~~Show~~ a ~~prompt with the respective strings~~.}}		End Sub
	~~AEvents~~.Message(ADS, "~~Message1~~", "~~AdditionalInfo1~~", False)		End Class

			{{APIComment\|'Set the new Events class.}}
			ADS.Events = New myEvents

			{{APIComment\|'Send a message.}}
			ADS.Events.Message(ADS, "message", "additional info", False)

← Older revision		Revision as of 23:35, 16 August 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[~~ALTAEvents~~ Class\|~~ALTAEvents~~]]}}		{{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}}