Table plus |
---|
applyColStyleToCell | true |
---|
heading | 0 |
---|
columnTypes | s,s,s,s |
---|
multiple | false |
---|
columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
---|
enableSorting | false |
---|
|
Syntax | runnerLog(message [, treatAsHtml], percent]) or runnerLog(message [, percent, action]) | Package | | Alias | | Pkg Usage | |
|
Description
Excerpt |
---|
|
Puts the 'message' on the console of a runner gadget. |
Puts the 'message' on the console of a runner gadget. The use of it has no effect in other places besides for the runner.
Parameters
Table plus |
---|
applyColStyleToCell | true |
---|
columnTypes | s,s,s,s |
---|
heading | 0 |
---|
multiple | false |
---|
enableSorting | false |
---|
|
Parameter name | Type | Required | Description |
---|
message | String | Yes | Specifies the message to be put on the runner console | percent | Number | No | Specifies the percent to be updated on the progress bar | action | String | No | Specifies the action to be executed (so far, the only action considered is init_progressBar - to initialize the progress bar; everything else will be ignored) | treatAsHtml | Boolean | No | Specifies either to show the message as a string, or treat it and render it in the browser as HTML code. |
|
Return Type
String
Return value has no meaning and should be ignored.
Examples
Example 1
Code Block |
---|
runnerLog("Hello " + userFullName(currentUsername()) + ". How are you today?"); |
Returns: Hello John Smith. How are you today?
Example 2
Using HTML as output.
Code Block |
---|
runnerLog("<font color='red'>This is a red text!</font>", true); |
This is a red text! (text will be red)
See also
Filter by label (Content by label) |
---|
showLabels | false |
---|
max | 25 |
---|
showSpace | false |
---|
cql | label = "basic_routine" and space = currentSpace ( ) |
---|
labels | array_routines |
---|
|