Standard Properties

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.

$activeIf true, the field reacts to user actions
$alignThe alignment or justification of the field
kCenterJst kLeftJst kRightJst
$alphaThe 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)
$ariadescribedbyThe name of a control used to describe this control. Use a comma-separated list of control names to specify multiple controls
$arialabelThe aria-label attribute's text. Use when a text label is not visible
$arialabelledbyThe name of a control to act as a label for this control. Use a comma-separated list of control names to specify multiple controls
$autoscrollIf true,and the client is not a mobile device,the client automatically displays scrollbar(s) when not all of the content is visible
$backalphaThe alpha component of the background color of the object (0-255, where 0 is completely transparent and 255 is opaque)
$backcolorThe background color of the field or window
$backgroundthemeSystem background theme for control or window
kBGThemeContainer kBGThemeControl kBGThemeMenu kBGThemeMenubar kBGThemeNone kBGThemeParent kBGThemeTabPane kBGThemeTabStrip kBGThemeWindow
$backpatternThe background pattern of the field or window
$bordercolorThe border color of the object
$candropcursorThe cursor which appears while dragging, when the mouse is over an area which will accept a drop
$canremotedebugwhenlockedIf true,the remote debugger can debug methods in the class when it is locked
$classdataThe binary representation of the data for the class
$classtypeThe type of the class
kCode kFile kFolder kMenu kObjectclass kQuery kRemoteForm kRemoteMenu kRemoteObject kRemoteTask kReport kSchema kSearch kSystemtable kTable kTask kToolbar kWindow
$componentctrlThe name of the external component control
$componenticonThe icon number used for the class in the Component Store
$componentinfoA row of information that provides metadata used when adding the control to the component store
$componentlibThe name of the external component library that contains the component
$componenttypeA constant which identifies how a class in the component store library behaves in the component store
kCompStoreDesignObjects kCompStoreHidden kCompStoreNewClassDefault kCompStoreSQLWizard kCompStoreTemplate kCompStoreWizard
$componentvalidIf true,the component has been instantiated
$containerThe field or instance containing the object
$contextmenuThe 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)
$createdateThe creation date for the class
$cssclassnameSpace 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
$cursorThe cursor which will appear when the mouse is moved inside the object
$datanameThe data name of the object
$dateformatThe format used to display and parse 'Date Time' data. A kJSFormat... constant
kJSFormatCustom kJSFormatFullDate kJSFormatFullDateTime kJSFormatLongDate kJSFormatLongDateTime kJSFormatMediumDate kJSFormatMediumDateTime kJSFormatNone kJSFormatShortDate kJSFormatShortDateTime kJSFormatTime
$dateformatcustomA 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'
$defaultappearanceA 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
$defaultdisabledappearanceIf 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
$defaultinactiveappearanceIf 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
$descA description of the item
$desgroupThe identifier of the head object of this group
$designactiveIf false, object is inactive in design mode
$designtasknameThe design task for the class used for displaying task variables
$deslockIf true, this field is locked in design mode
$disablefocusIf true, the field cannot receive the focus
$disablefontsizekeysIf true,you cannot use Ctrl+- on Windows or Cmnd+- on macOS to adjust the font size of the control
$disablesystemfocusIf 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)
$disksizeThe total disk size of the file (in bytes)
$dragborderIf true,the field can be sized by the user at runtime;only applies to fields with a kEFposn... floating property
$dragiconidThe icon which is dragged
$dragmodeThe drag mode of the object. kNoDragging, kDragData, kDragObject or kDragDuplicate
kDragData kDragDuplicate kDragObject kNoDragging
$dragrangeThe range which the field can be dragged
kRangeAll kRangeSubwindow kRangeTask kRangeWindow
$dropmodeThe drop mode of the object.A sum of kAccept... constants that specifies what can be dropped on the object
$edgefloatSpecifies 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
$effectThe 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
$enabledIf true, the field is enabled
$errortextThe error text to be displayed with the control
$errortextposA kJSErrorTextPos... constant that specifies where error text assigned using $errortext is to be displayed relative to the control
kJSErrorTextPosHidden kJSErrorTextPosRight kJSErrorTextPosUnder
$eventsThe list of events that the object will generate
$externalIf true,the class is external
$fieldstyleThe 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
$floatingIf true, the report field is floating
$fontThe font for the text
$fontsizeThe font size for the text
$fontstyleThe font style for the text
$forecolorThe foreground color of the object
$framehwndThe 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
$gridcolumnFor objects directly contained in a complex grid,the number of the complex grid column containing the object. Zero for all other objects
$hasfocusIf true, the field is the field which currently accepts typed characters
$hasshadowIf true, the control casts a shadow to give the appearance of elevation
$heightThe height of the field
$helpfileThe context help file name for the object (including sub path), in the library help folder ($clib.$helpfoldername)
$horzscrollIf true,the field or window has a horizontal scroll bar, or can scroll horizontally
$hscrollThe horizontal scroll position of the visible background. For the JavaScript client this is write-only
$hwndThe 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
$identThe unique numeric identifier of the item within its item group
$isallpanesIf true,the object (an immediate child of a tab pane or paged pane) appears on all panes of its container
$isprivateIf true, the instance or library is private
$issubwindowIf true, the class appears as a subwindow in the Component Store
$issupercomponentIf true, the class appears as a superclass in the Component Store
$keyeventsIf 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
$labelThe label text
$labelfontsizeThe 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%
$labelhottextcolorThe 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
$labeliscontenttipIf true, the label is shown as the content tip while the control is not focused and not displaying text
$labelpositionThe position of the label when not shown as the content tip. A kJSLabelPos... constant
kJSLabelPosAbove kJSLabelPosBorder kJSLabelPosInside kJSLabelPosLeft
$labeltextcolorThe 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
$leftThe position of the left-hand edge of the field
$linenoThe report line number of the object
$lineoffsetThe offset of the object from the top of the line
$linestyleThe line style for drawing the field border
$localIf true, the field is local
$moddateThe last modification date for the class
$mouseeventsIf 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
$nameThe name of the item
$nexttabobjectIf set, the name of the control which should receive focus after tabbing out of this control
$nodropcursorThe cursor which appears while dragging, when the mouse is over an area which will not accept a drop
$nolineifemptyIf true, the line is not printed if the field is empty
$noreloadIf true,the variable value is not reloaded at the start of the totals or subtotals section containing the object
$numberformatThe 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
$objlink32 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
$objtypeThe object type
$orderThe field number in tabbing order
$osdropflagsA sum of kOSDROP... constants that affect the behaviour of drag and drop from the operating system
$parentfolderThe $ident value of the folder class containing the class
$pastestripscontrolcharactersIf ($cobj.$pastestripscontrolcharacters|$clib.$prefs.$pastestripscontrolcharacters) controls with this property remove unused control characters when pasting character data.Control characters are 0-0x1f and 0x7f
$preventlayoutanimationIf true,and the form has $animatelayouttransitions enabled,this control will NOT animate to its new position when the form layout changes
$removefromtaborderIf 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)
$rmouseeventsIf 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
$screensizefloatThis property is deprecated and is now identical to $edgefloat.Use $edgefloat instead.
kEFall kEFbottom kEFleftRight kEFleftRightBottom kEFnone kEFright kEFrightBottom kEFrightTopBottom kEFtopBottom
$selectedIf true, the field is drawn with grab handles
$sessionobjectThe session object in use by the schema or table instance,or corresponding to the session in $sessions
$sessionobjrefThe session object reference in use by the schema or table instance,or corresponding to the session in $sessions
$showascheckedoutIf 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
$showcontrolcharactersIf ($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
$sidepanelIf true,an object which is a left or right toolbar component ($edgefloat kEFposnLeftToolBar or kEFposnRightToolBar) becomes a sidepanel
$sidepanelmodeA 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
$statuseventsIf 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
$sublenThe field length of an item of type character
$subtypeA constant or string representing the subtype of the item
$subwindowstyleIf true, the field uses the text style of the containing subwindow
$superclassThe name of the superclass for the class
$taborderThe resolved order in which the user will tab between controls. This is governed by $order, but relative to any container.
$textcolorThe text color of the object
$tooltipThe tooltip text for the object
$topThe position of the top edge of the field
$totalsifnolineIf true,totalled fields are accumulated when the line is skipped due to $nolineifempty
$typeA constant representing the type of the item
$userinfoA 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
$vcsrevisionThe 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
$versionThe version of the object
$vertextendIf true,the report field extends vertically
$vertscrollIf true,the field or window has a vertical scroll bar
$visibleIf true, the object is visible
$visibleinbreakpointIf true,the control is visible when the client is using the current layout breakpoint.There is a separate value stored for each layout breakpoint
$vscrollThe vertical scroll position of the visible background. For the JavaScript client this is write-only
$widthThe width of the field