ColdFusion.ProgressBar.start

Description

Starts the underlying Ext JS - JavaScript Library progress bar object.

Function syntax

ColdFusion.ProgressBar.start(name)

See also

ColdFusion.ProgressBar.getProgressBarObject, ColdFusion.ProgressBar.stop

History

ColdFusion 9: Added this function

Parameters

Parameter

Description

name

The name of the progress bar object.

Returns

This function does not return a value.

Usage

The cfprogressbar tag creates the HTML markup; at runtime, you use this function to initiate the progress bar object. On initialization, ColdFusion calls the underlying CFC, which is defined using a bind expression, at specified intervals. The CFC returns the progress status, which is passed to the underlying Ext progress bar object to update the progress bar value.

The progress status object that the CFC returns must have STATUS and MESSAGE properties. The STATUS property has a numeric value from 0.0 to 1.0