Operator Type:
Operator Scope of Action:
Operator Purpose:
Data Type Returned:
Operator First Added:
Operator in Current Baseline:
Operator Last Altered:
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
Syntax note: Operators without any defined mandatory arguments may omit their empty closing parentheses
String.show([backgroundColor[,colorString]])
String.show()
String.show
The String.show() function allows a plain-text message to be shown in the front window's message placard. The source text may be a literal string, variable or a String-type attribute value. The trailing parentheses are optional.
String.show() allows a further three 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 features and limitations of messages sent to the placard are described separately under the Message placards article.
The show(MsgString) operator offers a non-dot-operator alternative.
From v10.1.1, .show() takes an additional optional Number argument duration:
String.show(foreground, background, duration])
If passed, duration specifies the number of seconds for which to display the message. If not specified, the display duration is 3 seconds. Setting a duration can be useful if wanted to show a series of short messages, each in a discrete manner.
See also—notes linking to here: