$root.$iremoteforms.REMOTEFORM.$objs.file

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 
$actionAssign a kJSFileAction... constant to this property to instruct the client to perform the specified action
$allowmultipleAllows multiple files to be uploaded when set to kTrue. Some clients do not support this
$autocloseIf true, automatically closes upload dialog after upload operation is complete
$autouploadIf true, files are upload immediately after choosing
$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
$choosefilesbuttontextThe label of the choose file(s) button. If empty, defaults to: Choose File(s)
$choosefilesbuttontextposThe position of the label specified in $choosefilesbuttontext
kJSFileUploadLabelPosBottom kJSFileUploadLabelPosLeft kJSFileUploadLabelPosNone kJSFileUploadLabelPosRight kJSFileUploadLabelPosTop
$choosefilesiconidThe icon identifier used to reference the icon
$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)
$downloaderrortextThe error text displayed by the client when it detects a download error. If empty,defaults to: Download error
$hideuploadprogressIf true, hides the current file upload progress
$hideuploadprogressbatchIf true, hides the batch upload progress
$hyperlinktextThe text for the hyperlink. Only applicable when $showinline=kFalse
$hyperlinkurlThe URL for the hyperlink (this can be for a file download, but it can also be some other URL). Only applicable when $showinline=kFalse
$maincolorThe main color used throughout the control. Applies to upload area, upload button, progress bars, completion indicators.
$maxbatchuploadsizeThe maximum size in bytes of the batch of files to be uploaded to the server. Zero means no limit. Some clients cannot enforce this limit. Only available when $allowmultiple is kTrue
$maxbatchuploadsizeerrortextThe error text displayed by the client when $maxbatchuploadsize has been exceeded. Can contain one %n placeholder. If empty,defaults to: Total batch of files is larger than maximum allowed upload size (%1)
$maxfileuploadsizeThe maximum size in bytes of a file to be uploaded to the server. Zero means no limit. Some clients cannot enforce this limit
$maxfileuploadsizeerrortextThe error text displayed by the client when $maxfileuploadsize has been exceeded. Can contain two %n placeholders. If empty,defaults to: File size is larger than maximum allowed upload size (%1) %2
$showinlineIf true, the control is shown inline instead of using a dialog box
$stopuploadbuttontextThe label of the file upload dialog button to cancel an in-progress upload. If empty,defaults to: Cancel upload
$uploadbuttontextThe label of the file upload dialog button to start the upload. If empty,defaults to: Upload
$uploaderrortextThe error text displayed by the client when an upload error occurs. If empty,defaults to: Upload error
$uploadprogresstextThe progress text displayed during a file upload (when the browser can provide upload progress information). Must contain two %n placeholders. If empty,defaults to: %1 of %2
$uploadprogresstextbatchThe progress text displayed during a batch of file uploads (when the browser can provide upload progress information). Must contain two %n placeholders. If empty,defaults to: %1 of %2
$uploadprogresstextcolorThe text color in the progress elements
$uploadstoppedtextThe text displayed by the client when an upload has been cancelled. If empty,defaults to: Upload stopped
$uploadtitleThe title of the file upload dialog. If empty,defaults to: Upload file
$uploadtypesA comma separated list of file types to accept on upload (file extensions or MIME types), e.g. '.png, .jpg' or 'image/*'.
Standard$active $align $alpha $backalpha $backcolor $bordercolor $componentctrl $componentinfo $componentlib $contextmenu $cssclassname $dataname $disablesystemfocus $dragborder $dropmode $edgefloat $effect $errortext $errortextpos $events $fieldstyle $font $fontsize $height $ident $left $linestyle $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 
evDownloadSentSent to the file control when a file has been successfully sent to the client
Parameters
pEventCodeThe event code
pSuccessBoolean indicating whether download was successful
pIdentifierCharacter string to identify the download which has finished. Provided by the 4th col of the download row/list assigned to $dataname.
evFileUploadDialogClosedSent to the file control when the user closes the file upload dialog
Parameters
pEventCodeThe event code
evFileUploadedSent to the file control when a file has been successfully uploaded to the server
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