$root.$libs.LIB.$remoteforms.REMOTEFORM

Parent: $root.$libs.LIB.$remoteforms

Instance notation

Properties

Object specific
$aligntogrid If true, fields are snapped to the grid when they are moved
$alwaysenabledobject The name of the object that is always enabled regardless of event and server state; if an event is generated for this object when another event is in progress, the client sets $enabled for this object to kFalse until the user interface is available again
$cancelkeyobject The name of the object that will receive cancel events from the keyboard. For the JavaScript client this means the named object receives evClick when the user presses escape and the field with the focus does not use the key
$client A kClient... constant specifying the type of client to be used with this remote form. The set of controls available in the component store depends on the value of this property
kClientJavaScript
$collectperformancedata This property is only applied when $root.$prefs.$collectperformancedata has the value kCPDmarkedClasses. If true, method execution performance data is collected for all methods in the class
kFalse kTrue
$designshowmobiletitle If true, the remote form design window shows the mobile device title bar for relevant screen sizes. Set this property to false if you are designing the form to use with the client option to hide the title bar
$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)
$horzgrid The horizontal grid size
$inheritedorder The tabbing order for the first inherited field. Zero means maintain the designed order, from the base class through to this class; other values maintain compatibility with versions earlier than Studio 4,but you are recommended to use zero
$okkeyobject The name of the object that will receive ok events from the keyboard. For the JavaScript client this means the named object receives evClick when the user presses return or enter and the field with the focus does not use the key
$pathname The path to the class in the folder tree
$resizemode A kJSformResizeMode... constant that specifies how the form behaves when it initially opens and when the browser window resizes (this property does not apply to mobile devices or when the form is being used as a subform)
kJSformResizeModeAspect kJSformResizeModeCenter kJSformResizeModeFullkJSformResizeModeNone
$screensize The screen size for which the form is designed. A kSSZ... constant. Values other than kSSZDesktop only apply to mobile devices. Omnis remembers object coordinates for all kSSZ... values used, and uses the best kSSZ... value when running the form
kSSZDesktop kSSZjs320x480Landscape kSSZjs320x480Portrait kSSZjs768x1024Landscape kSSZjs768x1024Portrait
$serverlessclient If true, the remote form and its client scripts are to be included in the Serverless Client Application File (SCAF) for the library. Only assignable if your serial number enables Serverless Client development
$showgrid If true, the window displays a dotted grid in design mode
$sizetogrid If true, field sizes are restricted to being a multiple of the grid size
$startfield The order number of the initial enterable field of the remote form
$stringtabledata String table data. Not relevant for JavaScript client remote forms that use $stringtable in their remote task. The client automatically loads it, and sets the string table name to the remote form class name
$stringtabledesignform The name of the remote form class that appears as the last string table entry in the catalog when designing this remote form. Not relevant for JavaScript client remote forms that use $stringtable in their remote task
$title The window title
$vertgrid The vertical grid size
Standard $alpha $backalpha $backcolor $backpattern $classdata $classtype $componenticon $componenttype$contextmenu $createdate $defaultappearance $desc $designtaskname $disksize $events $external$forecolor $height $horzscroll $ident $issupercomponent $left $moddate $name $parentfolder$showascheckedout $superclass $top $userinfo $version $vertscroll $width

Methods

$clearperformancedata $clearperformancedata() Clears the performance data for all methods in the class
$findandreplace $findandreplace(cFind, cReplace [,bIgnoreCase=kTrue, bWholeWord=kFalse, bRegExp=kFalse, bClearLog=kFalse]) Replaces all instances in the class of cFind with cReplace. Returns a row of status information. bClearLog=kTrue clears the log first
$isa $isa(rClass) Returns true if the class or instance is a subclass of the specified class
$makeperformancedatalist $makeperformancedatalist() Returns a list containing the performance data collected for all methods in the class
$makesubclass $makesubclass(cName [,bAddLibPrefixForClib=kFalse]) creates a new subclass of the class, with the specified name (which can be prefixed by a library); bAddLibPrefixForClib controls whether $superclass of the new class has a library name prefix
$open $open([cInstName, iLocn=kWindowNormal, cons-params]) opens an instance of the window at location iLocn; cInstName = '*' means Omnis creates instance name. Passes cons-params to $construct. Returns item reference to window instance

Note that the above applies when the $openinwindow property is kTrue. If $openinwindow is kFalse, $open takes no parameters, and opens the remote form in a browser window.

Children

$cvardefs $cvars $inheritedobjs $insts
$ivardefs $methods $objs