Operator Type:
Operator Scope of Action:
Operator Purpose:
Data Type Returned:
Operator First Added:
Operator in Current Baseline:
Operator Last Altered:
Operator Has Newer Dot-Operator Variant:
Function [other Function type actions]
Item [operators of similar scope]
Data manipulation [other Data manipulation operators]
success boolean
v9.5.2
Baseline
As at baseline
Yes
show(msgString)
show(msgString, backgroundColor)
show(msgString, backgroundColor, colorString)
show(message[ foreground, background, duration)
The show(msgString) function allows a plain-text message to be shown in the front window's message placard. The source text, msgString, may be a literal string, variable or a String-type attribute value.
show() allows 3 further optional arguments.
The optional backgroundColor argument may be used on its own with or without the optional third colorString argument. But if the colorString argument is used, then the backgroundColor argument must be given as well. The same holds for the optional durationNum argument. If passed, durationNum specifies the number of seconds for which to display the message. Setting a duration can be useful if wanted to show a series of short messages, each in a discrete manner.
The full features and limitations of messages sent to the placard are described separately under the Message placards article.
The String.show() operator offers a dot-operator alternative.
See also—notes linking to here: