$root.$iremoteforms.REMOTEFORM

Parent: $root.$iremoteforms
Class notation

Properties

Object specific
$remotemenu The current remote menu instance. This is only set when evOpenContextMenu is being processed
$sqlobject The JavaScript client SQL object - only available in client-executed methods running in a wrapper application
Standard $classtype $container $isprivate $name

Methods

Object specific
$beginanimations $beginanimations(iDuration[,iCurve=kJSAnimationCurveEaseInOut]) after calling this,assignments to some properties are animated for iDuration milliseconds by $commitanimations() (JavaScript client)
$clientcommand

$clientcommand(cCommand,wRow) executes the command cCommand on the client machine using the parameters in the row variable wRow
Client commands

yesnomessage Open a yes-no message box
row(message text,title text,name of public form method called on yes,name of public form method called on no,name of public form method called on cancel (leave empty for no cancel button))
noyesmessage Open a no-yes message box
row(message text,title text,name of public form method called on yes,name of public form method called on no,name of public form method called on cancel (leave empty for no cancel button))
okcancelmessage Open an ok-cancel message box
row(message text,title text,name of public form method called on ok,name of public form method called on cancel (leave empty for no cancel button))
soundbell Sound the bell (unlikely to work on mobile devices with the JavaScript client)
row()
savepreference Save a value (as a character string) as a named preference on the client
row(preference name,preference value)
loadpreference Load a named preference value from the client preferences into an instance variable
row(preference name,instance variable name (e.g. a quoted string containing the name of the variable))
javamessage Show a message box on the client
row(style(error,warning,success,prompt,message,query),text,title text,openatmouse(bool),butt1text:methodname,butt2text:methodname,butt3text:methodname)
playsound Play a sound on the client (unlikely to work on mobile devices) (first supported file in row() is played,file 1 is also default if there is no HTML5 audio support)
row(name of sound file 1 in html sounds folder[,name of sound file 2,...])
setcustomformat Set the default custom date format used when $customformat is empty (defaults to D m y);for non-JS clients after using setcustomformat you must use $redraw for the form or any affected controls
row(date format)
lockui Lock the client user interface
row(lock indicator(bool which is true to lock the interface, false to unlock the interface))
subformset_add Add a set of subforms
row(setname,parent(pagedpanename:page|empty),flags,ordervar,formlist(cols:uniqueID,classname,params(literals only),title,left,top(left,top kSFScentercenter form),width,height[,landscape left,top,width,height]))
subformset_remove Remove a subform set from its parent and destruct all of its subforms
row(setname)
subformset_formadd Add subform to set
row(setname,uniqueID,classname,params(literals only),title,left,top(left,top kSFScenter center form),width,height,modal(0 non-modal,1 fully modal)[,landscape left,top,width,height])
subformset_formremove Remove a subform from a set and destruct it;if focus is kTrue, also set focus to the new top form in the set unless it is minimized
row(setname,unique id[,focus=kFalse])
subformset_formtofront Bring a subform in a set to the front
row(setname,unique id)
showpdf Open the specified PDF in a new window or tab
row({Omnis Server full pathname | Omnis Server temp PDF id},wait for PDF time in seconds[,user file name])
assignpdf Assign the specified PDF to the specified HTML control
row(HTML control name,PDF viewer parameters,{Omnis Server full pathname | Omnis Server temp PDF id},wait for PDF time in seconds[,user file name])
clearerrors Clears all errors set with $errortext for all objects on the form
row()
$commitanimations $commitanimations() animates the relevant property changes that have occurred after the matching call to $beginanimations() (iOS and JavaScript clients only)
$maximize $maximize() Maximizes the remote form instance if it is a member of a subform set
$minimize $minimize() Minimizes the remote form instance if it is a member of a subform set
$setcurfield $setcurfield(vNameOrIdentOrItemref[,bSelect=kFalse) sets the current field on the client machine and optionally if supported by the control selects all of its content. You can specify the field by name, ident, or item reference
$showmessage $showmessage(cMessage[,cTitle]) displays an OK message on the client machine using the specified cMessage and cTitle
 
Only one message can be shown in response to a single event. Executing $showmessage() more than once in response to the same event will result in a single Ok message with the text of the last call to $showmessage.
$showurl $showurl(cURL[,cFrame,cWindowProperties]) opens the URL in a new window or frame on the client machine
 
cURL specifies the URL of the HTML page. cFrame specifies the HTML frame name. If cFrame is empty, the page is displayed in a new window, otherwise it is displayed in the specified frame of the current window. 
 
The final optional parameter, cWindowProperties, is ignored if cFrame is not empty. Otherwise, it has the same format as the Javascript argument to window.open, for example "toolbar=0,menubar=1" specifies that the browser window will have a menubar, but not a toolbar. Possible keywords are: 
 
toolbar - specifies if the browser window has a toolbar 
status - specifies if the browser window has a status bar 
menubar - specifies if the browser window has a menu bar 
scrollbars - specifies if the browser window has scrollbars 
resizable - specifies if the browser window is resizable 
location - specifies whether the browser window has a location bar 
directories - specifies whether the browser window displays Web directories 
width - width of browser window 
height - height of browser window 
top - top coordinate of browser window 
left - left coordinate of browser window 
 
The keywords are all boolean (0 or 1) except for the width, height, top and left, which are numbers in pixel units.
Standard $canclose $close

Events

Object specific
evAnimationsComplete

The animations (started when $commitanimations was last called) have completed
Parameters

pEventCode The event code
evFormToTop

The remote form is about to become visible on the client
Parameters

pEventCode The event code
pScreenSize A kSSZ... constant for the current screen size on the client
evScreenOrientationChanged

The orientation of the screen displaying the form has switched between portrait and landscape
Parameters

pEventCode The event code
pScreenSize A kSSZ... constant for the current screen size on the client
evSubFormToTop

An existing remote form, contained in a subform that has $multipleclasses set to kTrue, is about to become visible on the client
Parameters

pEventCode The event code
Standard evExecuteContextMenu evOpenContextMenu

Children 

$ivars $methods $objs