SetProcessMessage - Display message in process dialog

Description

The SetProcessMessage function is used to display a message in the process dialog. This is especially useful for informing users about progress or status during the execution of processes. Additionally, an icon can be added or changed to enhance the visual presentation of the message.

Important: SetProcessMessage can only be used within the Process() function. This function must be defined in a button (createButton) or it will not work.

Syntax

SetProcessMessage(message, icon [, duration])

Arguments

Return Types

The function does not return a value. It is used solely to display a visual message.

Examples

createButton(
  1,
  "Start Process",
  "Starts the process and displays a message",
  "Process(
    SetProcessMessage('The process is running...', 'chart-pie-simple-circle-dollar')
  )",
  "",
  "",
  "",
  "The process has been started.",
  "",
  "cogs"
)

createButton(
  1,
  "Start Processing",
  "Displays a message for 5 seconds",
  "Process(
    SetProcessMessage('Data is being processed...', 'spinner', 5)
  )",
  "",
  "",
  "",
  "Processing has been started.",
  "",
  "hourglass-start"
)

createButton(
  1,
  "Complete Process",
  "Displays a completion message",
  "Process(
    SetProcessMessage('The process was successfully completed.', 'check-circle')
  )",
  "",
  "",
  "",
  "Process successfully completed.",
  "",
  "check-circle"
)

Changing Icons

To change the icon, replace the second parameter with the name of a supported icon. A complete list of available icons can be found in the Font Awesome Icon Library.

• Example for a success icon: check-circle
• Example for a loading icon: spinner
• Example for a warning icon: exclamation-triangle

Notes

• The SetProcessMessage function must be used within an interactive button and inside the Process() function.
• The message can be used to inform users about the progress of a process or a failure state.
• Choose icons that visually support the status or action to improve the user experience.
• Ensure that the message text is clear and understandable.