$root.$iremoteforms.REMOTEFORM.$objs.progress

Parent: $root.$iremoteforms.REMOTEFORM.$objs

Class notation

Properties

Warning: with the exception of $componentctrl, $componentlib, $ident, $name and $objtype, the values of properties can only be read in client methods.

Object specific
$::max The maximum value of the progress bar (a positive integer or zero)
$::value The current value of the progress bar. Must be between 0 and $max inclusive.
$disabledefaultcontextmenu If true, the default context menu for the object will not be generated in response to a context click ($clib.$disabledefaultcontextmenu and $cobj.$disabledefaultcontextmenu must both be false for the menu to be generated)
$progresscolor The color of the bar representing completed progress. Only applies when the standard HTML5 progress control is not available
$sendcarryon The progress control does not store a value for this property. Rather, $sendcarryon provides a mechanism to send an evCarryOn event to the progress control. To generate an evCarryOn event, assign kTrue to $sendcarryon

For the web client, $sendcarryon and evCarryOn provide a mechanism whereby a lengthy operation can be executed on the server, and the progress bar can be updated. In addition, when used with the remote form property $alwaysenabledobject, you can carry out a lengthy operation initiated from the remote form, which can be cancelled by the user.

For this mechanism to work, you must break the lengthy operation up into stages, where each stage is executed in the event processing for evCarryOn.

For example, consider a remote form with three controls:
a) A push button named "start" which starts the lengthy operation
b) A push button named "cancel" which cancels the operation
c) A progress control named "progress"

Set $alwaysenabledobject for the remote form to "cancel"

Add an instance variable called iCancelled.

evClick for the start button sets iCancelled to kFalse, and assigns kTrue to $sendcarryon for the progress control. This generates the first evCarryOn event for the progress control.

evClick for the cancel button sets iCancelled to kTrue.

evCarryOn for the progress control:
a) Checks iCancelled, and terminates processing if it is kTrue.
b) Carries out the next stage of the lengthy operation, and updates the progress control $val property.
c) Assigns kTrue to $sendcarryon, to generate the next evCarryOn event.

Note that the $event methods for the buttons and the progress control are server methods.
Standard $alpha $backalpha $backcolor $bordercolor $componentctrl $componentlib $contextmenu $cssclassname $disablesystemfocus $dragborder $edgefloat $errortext $errortextpos $events $fieldstyle $height $ident $left $name $objtype $order $tooltip $top $userinfo $visible $width

Events

Object specific
evCarryOn

Sent to the progress control after assigning kTrue to $sendcarryon; the event processing code for evCarryOn can assign $sendcarryon to kTrue again to generate the next evCarryOn
Parameters

pEventCode The event code
Standard evDragBorder evExecuteContextMenu evOpenContextMenu