The properties listed here are standard properties that apply to many different items. Items which have a standard property only include the property name in their property table - please use the entry here to read about the property.
$active | If true, the field reacts to user actions |
$align | The alignment or justification of the field kCenterJst kLeftJst kRightJst |
$alpha | The alpha value for the object (0-255, where 0 is completely transparent and 255 is opaque) (Windows 8 and later,JavaScript client,and macOS only) |
$ariadescribedby | The name of a control used to describe this control. Use a comma-separated list of control names to specify multiple controls |
$arialabel | The aria-label attribute's text. Use when a text label is not visible |
$arialabelledby | The name of a control to act as a label for this control. Use a comma-separated list of control names to specify multiple controls |
$autoscroll | If true,and the client is not a mobile device,the client automatically displays scrollbar(s) when not all of the content is visible |
$backalpha | The alpha component of the background color of the object (0-255, where 0 is completely transparent and 255 is opaque) |
$backcolor | The background color of the field or window |
$backgroundtheme | System background theme for control or window kBGThemeContainer kBGThemeControl kBGThemeMenu kBGThemeMenubar kBGThemeNone kBGThemeParent kBGThemeTabPane kBGThemeTabStrip kBGThemeWindow |
$backpattern | The background pattern of the field or window |
$bordercolor | The border color of the object |
$candropcursor | The cursor which appears while dragging, when the mouse is over an area which will accept a drop |
$canremotedebugwhenlocked | If true,the remote debugger can debug methods in the class when it is locked |
$classdata | The binary representation of the data for the class |
$classtype | The type of the class kCode kFile kFolder kMenu kObjectclass kQuery kRemoteForm kRemoteMenu kRemoteObject kRemoteTask kReport kSchema kSearch kSystemtable kTable kTask kToolbar kWindow |
$componentctrl | The name of the external component control |
$componenticon | The icon number used for the class in the Component Store |
$componentinfo | A row of information that provides metadata used when adding the control to the component store |
$componentlib | The name of the external component library that contains the component |
$componenttype | A constant which identifies how a class in the component store library behaves in the component store kCompStoreDesignObjects kCompStoreHidden kCompStoreNewClassDefault kCompStoreSQLWizard kCompStoreTemplate kCompStoreWizard |
$componentvalid | If true,the component has been instantiated |
$container | The field or instance containing the object |
$contextmenu | The context menu for the object.For remote form objects,a remote menu (@ means use default browser menu).For other objects, a menu (for lists and icon arrays,add ',Menu2' to specify a menu for clicks in white-space) |
$createdate | The creation date for the class |
$cssclassname | Space separated list of CSS class names to be applied to the control. To override a property used by the JavaScript client you must mark it with !important in the style sheet. Add your CSS classes to css/user.css |
$cursor | The cursor which will appear when the mouse is moved inside the object |
$dataname | The data name of the object |
$dateformat | The format used to display and parse 'Date Time' data. A kJSFormat... constant kJSFormatCustom kJSFormatFullDate kJSFormatFullDateTime kJSFormatLongDate kJSFormatLongDateTime kJSFormatMediumDate kJSFormatMediumDateTime kJSFormatNone kJSFormatShortDate kJSFormatShortDateTime kJSFormatTime |
$dateformatcustom | A JS date-time format string.Used to format and parse the data if $dateformat is kJSFormatCustom and data type is 'Date Time'.Several formats separated by | provide alternatives for parsing.Also see $clientcommand 'setcustomformat' |
$defaultappearance | A kAppearance... constant that specifies the native appearance with which to render native JS controls in clients which do not have a supported OS kAppearanceAndroid kAppearanceBlackberry kAppearanceiOS kAppearanceWinRT |
$defaultdisabledappearance | If true, the control uses a default appearance when disabled. If false, the appearance remains unchanged apart from any built-in browser styling that applies to its HTML attributes |
$defaultinactiveappearance | If true,the control uses a default appearance when inactive. If false, the appearance remains unchanged apart from any built-in browser styling that applies to its HTML attributes |
$desc | A description of the item |
$desgroup | The identifier of the head object of this group |
$designactive | If false, object is inactive in design mode |
$designtaskname | The design task for the class used for displaying task variables |
$deslock | If true, this field is locked in design mode |
$disablefocus | If true, the field cannot receive the focus |
$disablefontsizekeys | If true,you cannot use Ctrl+- on Windows or Cmnd+- on macOS to adjust the font size of the control |
$disablesystemfocus | If true,the standard focus ring is not drawn around the control when it has the focus (applies to JavaScript client controls, or to macOS when $root.$prefs.$showsystemfocus is kTrue) |
$disksize | The total disk size of the file (in bytes) |
$dragborder | If true,the field can be sized by the user at runtime;only applies to fields with a kEFposn... floating property |
$dragiconid | The icon which is dragged |
$dragmode | The drag mode of the object. kNoDragging, kDragData, kDragObject or kDragDuplicate kDragData kDragDuplicate kDragObject kNoDragging |
$dragrange | The range which the field can be dragged kRangeAll kRangeSubwindow kRangeTask kRangeWindow |
$dropmode | The drop mode of the object.A sum of kAccept... constants that specifies what can be dropped on the object |
$edgefloat | Specifies how the field resizes when its container field or window resizes kEFall kEFbottom kEFleftRight kEFleftRightBottom kEFnone kEFposnBottomToolBar kEFposnClient kEFposnHorzHeader kEFposnJoinHeaders kEFposnLeftToolBar kEFposnMainHeader kEFposnMenuBar kEFposnRightToolBar kEFposnStatusBar kEFposnTopToolBar kEFposnVertHeader kEFright kEFrightBottom kEFrightTopBottom kEFtopBottom |
$effect | The drawing style of the frame for a field object kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
$enabled | If true, the field is enabled |
$errortext | The error text to be displayed with the control |
$errortextpos | A kJSErrorTextPos... constant that specifies where error text assigned using $errortext is to be displayed relative to the control kJSErrorTextPosHidden kJSErrorTextPosRight kJSErrorTextPosUnder |
$events | The list of events that the object will generate |
$external | If true,the class is external |
$fieldstyle | The style in system class #STYLES assigned to this field. For JavaScript client controls,$fieldstyle can be changed to a new style at runtime,but it cannot be set to empty |
$floating | If true, the report field is floating |
$font | The font for the text |
$fontsize | The font size for the text |
$fontstyle | The font style for the text |
$forecolor | The foreground color of the object |
$framehwnd | The window identifier of the outermost enclosing window of the object. The properties of $framehwnd are not assignable. Set a reference to object.$framehwnd.$ref, to access its properties |
$gridcolumn | For objects directly contained in a complex grid,the number of the complex grid column containing the object. Zero for all other objects |
$hasfocus | If true, the field is the field which currently accepts typed characters |
$hasshadow | If true, the control casts a shadow to give the appearance of elevation |
$height | The height of the field |
$helpfile | The context help file name for the object (including sub path), in the library help folder ($clib.$helpfoldername) |
$horzscroll | If true,the field or window has a horizontal scroll bar, or can scroll horizontally |
$hscroll | The horizontal scroll position of the visible background. For the JavaScript client this is write-only |
$hwnd | The window identifier of the main window of the object. The properties of $hwnd are not assignable. Set a reference to object.$hwnd.$ref, to access its properties |
$ident | The unique numeric identifier of the item within its item group |
$isallpanes | If true,the object (an immediate child of a tab pane or paged pane) appears on all panes of its container |
$isprivate | If true, the instance or library is private |
$issubwindow | If true, the class appears as a subwindow in the Component Store |
$issupercomponent | If true, the class appears as a superclass in the Component Store |
$keyevents | If true,keyboard events (evKey) are generated.If the library preference $keyevents is true it affects all foreground objects that have a $keyevents property.The object property only applies when the library preference is false |
$label | The label text |
$labelfontsize | The font size for the label text when not shown as the content tip. When this is 0 on the desktop client the label fontsize will be the controls fontsize but reduced by 15% |
$labelhottextcolor | The label text color when the control is focused. By default, this is the same as the focused border color on JS Client and the controls text color for the desktop client |
$labeliscontenttip | If true, the label is shown as the content tip while the control is not focused and not displaying text |
$labelposition | The position of the label when not shown as the content tip. A kJSLabelPos... constant kJSLabelPosAbove kJSLabelPosBorder kJSLabelPosInside kJSLabelPosLeft |
$labeltextcolor | The label text color. By default, this is the border color tinted with the text color on JS Client and kColorGrayText in for the desktop client |
$left | The position of the left-hand edge of the field |
$lineno | The report line number of the object |
$lineoffset | The offset of the object from the top of the line |
$linestyle | The line style for drawing the field border |
$local | If true, the field is local |
$moddate | The last modification date for the class |
$mouseevents | If true,standard mouse events are generated.If the library preference $mouseevents is true it affects all foreground objects that have a $mouseevents property.The object property only applies when the library preference is false |
$name | The name of the item |
$nexttabobject | If set, the name of the control which should receive focus after tabbing out of this control |
$nodropcursor | The cursor which appears while dragging, when the mouse is over an area which will not accept a drop |
$nolineifempty | If true, the line is not printed if the field is empty |
$noreload | If true,the variable value is not reloaded at the start of the totals or subtotals section containing the object |
$numberformat | The JS number format used to display 'Number' and 'Integer' data. sprintf syntax with a single % format tag for the number; F and D in upper case behave like f and d respectively,except that they also insert the thousands separator |
$objlink | 32 bit integer identifying container of object.Zero if object is top level;otherwise,low-order 16 bits are $order of container and high-order 16 bits are either zero,page or tab number for paged/tab panes,or column and section for complex grid |
$objtype | The object type |
$order | The field number in tabbing order |
$osdropflags | A sum of kOSDROP... constants that affect the behaviour of drag and drop from the operating system |
$parentfolder | The $ident value of the folder class containing the class |
$pastestripscontrolcharacters | If ($cobj.$pastestripscontrolcharacters|$clib.$prefs.$pastestripscontrolcharacters) controls with this property remove unused control characters when pasting character data.Control characters are 0-0x1f and 0x7f |
$preventlayoutanimation | If true,and the form has $animatelayouttransitions enabled,this control will NOT animate to its new position when the form layout changes |
$removefromtaborder | If true,the control is not included in the tab order for the remote form (note that with the exception of the complex grid (which cannot be removed) if a control does not have this property it is always excluded from the tab order) |
$rmouseevents | If true,right button mouse events are generated.If the library preference $rmouseevents is true it affects all foreground objects that have a $rmouseevents property.The object property only applies when the library preference is false |
$screensizefloat | This property is deprecated and is now identical to $edgefloat.Use $edgefloat instead. kEFall kEFbottom kEFleftRight kEFleftRightBottom kEFnone kEFright kEFrightBottom kEFrightTopBottom kEFtopBottom |
$selected | If true, the field is drawn with grab handles |
$sessionobject | The session object in use by the schema or table instance,or corresponding to the session in $sessions |
$sessionobjref | The session object reference in use by the schema or table instance,or corresponding to the session in $sessions |
$showascheckedout | If true,the browser marks the class as checked out from the VCS.If false,and the VCS build date for the library is not empty,and the preference $alloweditifnotcheckedout is false,the class cannot be edited |
$showcontrolcharacters | If ($cobj.$showcontrolcharacters|$clib.$prefs.$showcontrolcharacters) controls with this property draw control characters using a suitable symbol rather than space.Control characters are 0-0x1f and 0x7f |
$sidepanel | If true,an object which is a left or right toolbar component ($edgefloat kEFposnLeftToolBar or kEFposnRightToolBar) becomes a sidepanel |
$sidepanelmode | A kSidePanelMode... constant that specifies how a sidepanel is displayed in peek mode. Peek mode shows or hides the panel automatically as the mouse enters its region kSidePanelModeCover kSidePanelModeNone kSidePanelModePush |
$statusevents | If true,status events (evDisabled,evEnabled,evHidden,evShown) are generated.If the library preference $statusevents is true it affects all objects.The object property only applies when the library preference is false |
$sublen | The field length of an item of type character |
$subtype | A constant or string representing the subtype of the item |
$subwindowstyle | If true, the field uses the text style of the containing subwindow |
$superclass | The name of the superclass for the class |
$taborder | The resolved order in which the user will tab between controls. This is governed by $order, but relative to any container. |
$textcolor | The text color of the object |
$tooltip | The tooltip text for the object |
$top | The position of the top edge of the field |
$totalsifnoline | If true,totalled fields are accumulated when the line is skipped due to $nolineifempty |
$type | A constant representing the type of the item |
$userinfo | A developer property that can store data of any type.The property manager only allows assignment if its current value is empty,null,or has character or integer data type.Must be character to be used with client methods in the JavaScript client |
$vcsrevision | The revision number of the class (managed by the VCS). Zero if the library was not built by the VCS, or if the library was built prior to Omnis Studio 10.2 |
$version | The version of the object |
$vertextend | If true,the report field extends vertically |
$vertscroll | If true,the field or window has a vertical scroll bar |
$visible | If true, the object is visible |
$visibleinbreakpoint | If true,the control is visible when the client is using the current layout breakpoint.There is a separate value stored for each layout breakpoint |
$vscroll | The vertical scroll position of the visible background. For the JavaScript client this is write-only |
$width | The width of the field |