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

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

Class notation

Properties Methods Events 

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 
$::maxThe maximum value of the progress bar (a positive integer or zero)
$::valueThe current value of the progress bar.Must be between 0 and $max inclusive.
$borderradiusRadius for rounded border corners.1 to 4 pixel values separated by -,in order topleft,topright,bottomright,bottomleft.If bottomleft is omitted it is topright.If bottomright is omitted it is topleft.If topright is omitted it is topleft
$disabledefaultcontextmenuIf 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)
$progressanimationAnimate the progress bar. Only applies when $usesystemappearance is set to kFalse
$progresscolorThe color of the bar representing completed progress. May not apply in some browsers when $usesystemappearance is set to kTrue
$secondarycolorThe color of the stripes on the progress bar. Only applies when $usesystemappearance is set to kFalse
$sendcarryonThe 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.
$usesystemappearanceUse the default appearance given by the browser
Standard$active $alpha $ariadescribedby $arialabel $arialabelledby $backalpha $backcolor $bordercolor $componentctrl $componentinfo $componentlib $contextmenu $cssclassname $defaultinactiveappearance $disablesystemfocus $dragborder $dropmode $edgefloat $errortext $errortextpos $events $fieldstyle $height $ident $left $name $nexttabobject $objtype $order $preventlayoutanimation $removefromtaborder $sidepanel $sidepanelmode $tooltip $top $userinfo $visible $visibleinbreakpoint $width

Methods

$showpanel$showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client

Events

Object specific 
evCarryOnSent 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
pEventCodeThe event code
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
StandardevCanDrop evDragBorder evDrop evExecuteContextMenu evHidden evOpenContextMenu evShown

Children

Top 

$methods