lfGlobalMessage (Power Scripts)
Syntax | lfGlobalMessage(message [, messageClass, messageSize]); | Package |
|
Alias |
| Pkg Usage |
|
Description
Displays a global message.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
message | String | Yes | Message to display |
messageClass | String | No | Message type |
messageClass | String | No | Message type. Options are ERROR, WARNING, SUCCESS, and INFO (default). |
messageSize | String | No | Message size. Options are SMALL, MEDIUM (default), and BIG. |
Return Type
None
Example
Use the following code to display a global error message.
lfGlobalMessage("This is a global message!", "ERROR", "BIG"); // where message = "This is a global message!" and messageClass = "ERROR" and messageSize = "BIG"The messageClass parameter can be:
ERROR: will display an error message
WARNING: will display a warning message
SUCCESS: will display a success message
INFO: will display an info message
If the messageClass is not specified an info message will be displayed as default.