ColdFusion.ProgressBar.updatestatus

Description

Lets you manually update the status and message of the progress bar.

Function syntax

ColdFusion.ProgressBar.updatestatus(progressBarId, status, message)

See also

ColdFusion.ProgressBar.update, ColdFusion.ProgressBar.reset

History

ColdFusion 9: Added this function

Parameters

Parameter

Description

progressBarId

Name of the progress bar object. This must be a valid ColdFusion identifier.

message

Text to be displayed in the progress bar.

status

Progress status.

Returns

This function does not return a value.

Usage

This function helps you to manually set the message and status in the progress bar. For instance, in the case of file upload, you can manually control the progress using this function.

The following snippet illustrates how to use the function:

<cfform> 
<cfprogressbar name="pBar" width="500"/> 
<cfinput type="button" name="pBtn" onClick=" ColdFusion.ProgressBar.updateStatus('pBar',0.5,'50%')"> 
</cfform>