$root.$iremoteforms.REMOTEFORM

Properties

Object specific
$field
$inherited	Used when referring to a method or variable defined in a superclass
$layoutbreakpoints	The comma separated list of layout breakpoints of the different layouts of this responsive layout remote form.Must contain at least one value
$layouttype	A kLayoutType... constant that specifies how the layout of the form is designed.Only assignable as a property of a remote form class when the remote form does not contain any controls kLayoutTypeResponsive kLayoutTypeScreen kLayoutTypeSingle
$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 $ident $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.wRow can be omitted if the command does not expect any parameters
Client commands

yesnomessage	Open a yes-no message box with optional cancel button if you supply the cancel form method name row(cMessageText,cTitleText,cPublicFormMethodNameCalledOnYes,cPublicFormMethodNameCalledOnNo[,cPublicFormMethodNameCalledOnCancel])
noyesmessage	Open a no-yes message box with optional cancel button if you supply the cancel form method name row(cMessageText,cTitleText,cPublicFormMethodNameCalledOnYes,cPublicFormMethodNameCalledOnNo[,cPublicFormMethodNameCalledOnCancel])
okcancelmessage	Open an ok message box with optional cancel button if you supply the cancel form method name row(cMessageText,cTitleText,cPublicFormMethodNameCalledOnOk[,cPublicFormMethodNameCalledOnCancel])
soundbell	Sound the bell (unlikely to work on mobile devices) row()
savepreference	Save a value (as a character string) as a named preference on the client row(cPreferenceName,cPreferenceValue)
loadpreference	Load a named preference value from the client preferences into an instance variable row(cPreferenceName,cInstanceVariableName)
javamessage	Show a message box on the client row('error'\|'warning'\|'success'\|'prompt'\|'message'\|'query',cMessageText,cTitleText,bOpenAtMouse,cButt1text:methodname,cButt2text:methodname,cButt3text:methodname)
playsound	Play a sound from the HTML sounds folder (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(cNameOfSoundFile1[,cNameOfSoundFile2,...])
setcustomformat	Set the default custom date format used when $customformat is empty (defaults to D m y) row(cDateFormat)
lockui	Lock the client user interface row(bLock)
subformset_add	Add subform set defined by list with cols vUnqID,cClass,cParams,cTitle,iLeft<int\|kSFScenter>,iTop<int\|kSFScenter>,iWid,iHt[,iLndscpLeft,iTop,iWid,iHt] row(cSetname,cParent<pagedpanename:page\|sboxname\|empty>,iFlags,cOrdervar,lFormlist)
subformset_remove	Remove a subform set from its parent and destruct all of its subforms row(cSetname)
subformset_formadd	Add subform to set row(cSetname,vUniqueID,cClass,cParams,cTitle,iLeft<int\|kSFScenter>,iTop<int\|kSFScenter>,iWidth,iHeight,iModal<0 non-modal\|1 fully modal>[,iLandscapeLeft,iTop,iWidth,iHeight])
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(cSetname,vUniqueID[,bFocus=kFalse])
subformset_formtofront	Bring a subform in a set to the front row(cSetname,vUniqueID)
showpdf	Open the specified PDF in a new window or tab row({cOmnisServerFullPathname\|cOmnisServerTempPDFid},iSecondsToWaitForPDF[,cUserFileName])
assignpdf	Assign the specified PDF to the specified HTML control row(cHTMLControlName,cPDFViewerParameters,{cOmnisServerFullPathname\|cOmnisServerTempPDFid},iSecondsToWaitForPDF[,cUserFileName])
clearerrors	Clears all errors set with $errortext for all objects on the form row()
openpush	Establishes a push connection to the Omnis Server for the remote task (see remote form instance method $pushdata) row([iMaxPollDelayMillisecs=1000,iMaxTries=5,cRetryCodes='500-599'])
closepush	Closes an open push connection to the Omnis Server row()
readfile	Reads and then closes file identified by file ident (supplied to evDrop) and stores its data in named instance variable (as base64 or text);calls $filereadcomplete when the read has completed row(iIdent,cInstanceVariableName,bBase64)
closefile	Closes a file or files supplied by the drag value of kDragFiles to evDrop;all files supplied to evDrop must be closed to free up resources;ident is zero to close all files,or the ident of one file to close row(iIdent)
showloadingoverlay	Shows or hides a loading overlay over a control or the entire form row(bShow,cControlNameOrEmpty,cText[,cCSSclass])
enablepushnotifications	Enables or disables push notifications on the client. Only applies when running inside a wrapper app row(bEnable)
speakmessage	Tells assistive technology to announce a message. Used to convey information or changes to visually impaired users row(cMessage,bInterruptCurrentSpeech)
showtoast	Displays a small popup message that disappears after a timeout row(cText[,iTimeoutMillisecs=5000,iPosX=#NULL,iPosY=#NULL,cContainerName='',bFixed=kTrue,iOriginX=kLeftJst,iOriginY=kJstVertTop,bSpeak=kTrue,bInterruptCurrentSpeech=kFalse])
subformdialogshow	Opens a modal subform,to which the user must respond before continuing row(cClass,cParams,cTitle,iWidth,iHeight[,bCloseButton=kTrue,bResizable=kFalse,bMaxButton=kFalse,bOpenMax=kFalse])
subformdialogclose	Closes the top most modal subform, which has been opened with clientcommand 'subformdialogshow'
setlocale	Overrides the client locale setting (Only takes affect once application has been reloaded),if cPromptToReload=kTrue displays no/yes dialog to user to reload row(cLocale[,cPromptToReload=kFalse])
clearlocale	Removes any overriden locale settings (Only takes affect once application has been reloaded),if cPromptToReload=kTrue displays no/yes dialog to user to reload row([cPromptToReload=kFalse])
settheme	Sets the client's theme (requires page reload on the client to take effect). This will be remembered on subsequent reloads row(cThemeName)
subformpaletteshow	Shows a palette style subform row(cClass,cParams,cControl,iWidth,iHeight[,iPositionFlags,bShowOverlay=kFalse,cTitle,bPreventClose=kFalse])
subformpaletteclose	Close the topmost palette

$closeurl

$closeurl(cID) Closes the browser window with the specified ID (returned from $showurl())

$commitanimations

$commitanimations() animates the relevant property changes that have occurred after the matching call to $beginanimations()

$copytoclipboard

$copytoclipboard(vDataToCopy[,cMIMEType='text/plain',bDataIsBinary=kFalse]) copies vDataToCopy to the user's clipboard (character or binary depending on the value of bDataIsBinary). cMIMEType is the MIME type of the data

$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

$pushdata

$pushdata(wRow[,&cErrorText]) See $clientcommand openpush.Pushes row wRow to client.Results in a call to the client-executed method $pushed in the remote form instance on the client,passing wRow as the parameter.wRow must be JSON compatible

$pushhistorystate

$pushhistorystate(wRow[,bReplaceState=kFalse]) Pushes (or replaces) a custom history state object (an Omnis row) onto the history stack. Used with $applynewhistory to customize browser back/forward behavior

$rollbackhistory

$rollbackhistory([iCount=0,bPreventNotify=kFalse]) Roll back iCount number of custom history states that have been added using $pushhistorystate(). Pass 0 to remove all custom history

$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. Returns a Character string identifier for the opened window, which can be passed to $closeurl() to close the window.

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
pOrientation	The new orientation of the device - kOrientPortrait or kOrientLandscape

evLayoutChanged

The current layout breakpoint has changed
Parameters

pEventCode	The event code
pBreakpoint	The integer value of the new layout breakpoint

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
pOrientation	The new orientation of the device - kOrientPortrait or kOrientLandscape

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