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

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

Instance notation

Properties Methods 

Properties

Object specific 
$aligntogridIf true,fields are snapped to the grid when they are moved
$alwaysenabledobjectThe 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
$animatelayouttransitionsIf true,all controls (which do not opt out using their $preventlayoutanimation property) will be animated to their new positions/sizes when the form's layout changes
$cancelkeyobjectThe name of the object that will receive cancel events from the keyboard.The named object receives evClick when the user presses escape and the field with the focus does not use the key
$clientA 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
$collectperformancedataThis 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
$designguidesA comma separated string of design guides. L25,T50 (left 25px,top 50px). Left top, right and bottom values supported.
$designshowmobiletitleIf 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
$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)
$editorThe name of the add-in tool library used to edit this class
$editordataEditor data stored with the class.Typically used by the library identified by $editor
$horzgridThe horizontal grid size
$inheritedorderThe 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
$layouttypeA 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
$menulineheightThe height of menu lines. Applies to context menus and control menus. Actual height will be no less than the height of text in the menu
$okkeyobjectThe name of the object that will receive ok events from the keyboard.The named object receives evClick when the user presses return or enter and the field with the focus does not use the key
$pathnameThe path to the class in the folder tree
$resizemodeA 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 kJSformResizeModeFull kJSformResizeModeNone
$screensizeThe 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
$serverlessclientIf 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
$showgridIf true,the window displays a dotted grid in design mode
$sizetogridIf true,field sizes are restricted to being a multiple of the grid size
$startfieldThe order number of the initial enterable field of the remote form
$stringtabledataString 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
$stringtabledesignformThe 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
$titleThe window title
$vertgridThe vertical grid size
Standard$alpha $backalpha $backcolor $backpattern $canremotedebugwhenlocked $classdata $classtype $componenticon $componentinfo $componenttype $contextmenu $createdate $defaultappearance $desc $designtaskname $disksize $events $external $forecolor $height $horzscroll $ident $issupercomponent $left $moddate $name $parentfolder $showascheckedout $superclass $top $userinfo $vcsrevision $version $vertscroll $width

Methods

$clearperformancedata$clearperformancedata() Clears the performance data for all methods in the class
$findandreplace$findandreplace(cFind,cRep[,bIgnCase=kTrue,bWholeWord=kFalse,bRegExp=kFalse,bClearLog=kFalse,bReturnLog=kFalse]) If cRep is #NULL,finds all instances of cFind;otherwise,replaces all instances of cFind with cRep.Returns status row
$isa$isa(rClass|rExternalObject) Returns true if the class or instance is a subclass of the specified class or external object
$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() opens the remote form in a browser
$removecodefolding$removecodefolding() Removes code folding from all methods in the class. Returns the number of methods from which code folding was removed

Children

Top 

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