Adds an error message that will be displayed to the user. This method supports the addition
of a pre-defined message that supports multiple languages and the substitution of variables.
Messages are removed automatically by the system once they have been displayed to the user.
A message is added using its message number. Numbered messages are defined within each project using the Messages Editor -
double click on the Messages element within each project in the designer tree. Within each message, a
substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the replaceParameters
parameter (see example below).
When stopProcessing is true, all processing for the current event is stopped immediately and the page
is redisplayed to the user so the error can be corrected. When stopProcessing is false, processing
continues normally, except that the user is prevented from navigating forwards to another page using a
Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same
restriction does not apply when navigating to another page using other methods e.g. the WebForm#gotoPage(Page) method.
Set stopProcessing to false when there is a requirement to display multiple error messages on a page.
EventContext#stopExecution() can then be used at a later point to stop processing and display the messages to the user.
Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page
represented by a Message Control. For further information on the location and styling of messages, please see the online
documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.
If message 1006 in language EN contains text: Order type && is invalid for customer type &&
this might be displayed as: Order type CREDIT is invalid for customer type PUBLIC
Parameters
int
messageNo,
UNKNOWNjava.lang.String[]
replaceParameters,
boolean
stopProcessing,
A message is added using its message number. Numbered messages are defined within each project using the Messages Editor - double click on the Messages element within each project in the designer tree. Within each message, a substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the
replaceParametersparameter (see example below).When
stopProcessingistrue, all processing for the current event is stopped immediately and the page is redisplayed to the user so the error can be corrected. WhenstopProcessingisfalse, processing continues normally, except that the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm#gotoPage(Page) method.Set
stopProcessingtofalsewhen there is a requirement to display multiple error messages on a page. EventContext#stopExecution() can then be used at a later point to stop processing and display the messages to the user.Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.
Javascript example:
If message 1006 in languageENcontains text:Order type && is invalid for customer type &&
this might be displayed as:
Order type CREDIT is invalid for customer type PUBLIC