Salesforce

ProgressDialogSet (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

ProgressDialogSet

Defines the title and message that will be seen in the progress indicator.

The function does not show the progress indicator. It only defines the appearance that will be used the next time the progress indicator is to be seen.

Syntax:

ProgressDialogSet (title, message)

Parameters:

title – A string to be used as the title of the progress dialog.

message – A string to be used as the message of the progress dialog.

Returns:

Logical – True for Success or False for Failure

Note:

  • If both the title and message parameters have values, instead of a progress indicator, a dialog window will be seen with the title, message and a spinner. It will appear according to the operating system's native behavior.

  • If the message is an empty string, only the title and spinner will be seen.

  • If the title is an empty string, the dialog will not contain a title. It will appear according to the operating system's native behavior.

  • If the function is not executed or if both the title and message are set to an empty string, a progress indicator will be shown without a dialog window.

Exceptions:

This is a client-side function that is only available for Rich Client tasks.

This function is not supported in Web Client tasks.

Platform specific:

This function is only supported for mobile devices.

Since version: 3.3

Reference
Attachment 
Attachment