The preference items
| $alloweditifnotcheckedout | If true, you can edit a class that is not marked as checked out,when the library containing the class has been built using the VCS |
| $alwaysshowmainmenu | If true,the main menu is always visible.$alwaysshowmainmenu can only be set to false when running on Windows Vista,in which case you can press the left-alt key to temporarily display the main menu when required |
| $appearance | A row of information that configures the appearance of various items in the environment.For each color,kColorDefault means use the default color for the system |
| $appendfile | If true,and printing to file,the file is appended instead of being replaced |
| $backgroundiconid | The icon id of the image centered on the main Omnis Studio Window (Windows only) |
| $cdrom | If true, the serial number does not allow Omnis to write to data files and libraries |
| $charsperinch | Number of characters per inch when printing to a text device |
| $charsperline | Characters per line when printing to text device and $restrictpagewidth is true |
| $codeassistanttimer | The time elapsed since pressing a key,after which the code assistant popup will appear if suggestions are available (milliseconds) |
| $collectperformancedata | A kCPD... constant specifying how Omnis collects method execution performance data.Data collected is stored with each method in its class,and can be accessed using the notation.Data is not collected for remote form client methods kCPDallMethods kCPDmarkedClasses kCPDnone |
| $copies | Number of copies to be printed |
| $disablereportcopy | If true,copy selection is disabled for user (non-IDE) screen report and page preview windows. Changing this property does not affect copy selection for screen report and page preview windows that are already open |
| $disablereportworkingmessage | If true,the 'Sending report to...' working message is not shown when printing a report |
| $disablesystemidlesleep | If true,the system will be prevented from going into idle sleep if blocking idle sleep is allowed |
| $disablesystemidlesleepreason | When idle sleep is blocked then this is the reason logged by the system |
| $exportbom | If true, and the $exportencoding preference identifies a Unicode encoding, a Unicode BOM is output at the start of the output file |
| $exportencoding | The encoding used for exporting data and printing to port or text file. Any of the kUniType... constants, except Auto,Character and Binary kUniTypeAnsiArabic kUniTypeAnsiBaltic kUniTypeAnsiCentralEuropean kUniTypeAnsiCyrillic kUniTypeAnsiGreek kUniTypeAnsiHebrew kUniTypeAnsiLatin1 kUniTypeAnsiThai kUniTypeAnsiTurkish kUniTypeAnsiVietnamese kUniTypeISO8859_1 kUniTypeISO8859_10 kUniTypeISO8859_11 kUniTypeISO8859_13 kUniTypeISO8859_14 kUniTypeISO8859_15 kUniTypeISO8859_16 kUniTypeISO8859_2 kUniTypeISO8859_3 kUniTypeISO8859_4 kUniTypeISO8859_5 kUniTypeISO8859_6 kUniTypeISO8859_7 kUniTypeISO8859_8 kUniTypeISO8859_9 kUniTypeNativeCharacters kUniTypeOEM kUniTypeUTF16 kUniTypeUTF16BE kUniTypeUTF16LE kUniTypeUTF32 kUniTypeUTF32BE kUniTypeUTF32LE kUniTypeUTF8 |
| $exportimportjsonoptions | A row containing parameters that affect the behaviour of $root.$comparejson(), $root.$exportjson() and $root.$importjson() |
| $exportnullsasempty | If true, Omnis exports NULLs as empty values in one field per line, tab and comma delimited exports |
| $fullscreen | If true, Omnis is running in fullscreen mode |
| $generatepages | If true,and printing to text device,pages are generated |
| $helpbaron | If true, the help bar is displayed |
| $helpfont | The font and point size for the help bar and balloons e.g. 'Arial;10' |
| $hideuntilcomplete | If true,screen/preview report window is hidden until report is complete |
| $idelistpointsize | The point size used for the standard list font on key IDE windows; to restore the default value, assign zero to this property |
| $idetools | Identifies the optional IDE tools which are currently available using the tools menu and toolbar |
| $importencoding | The encoding used for imported data when importing from port,or when the import file does not have a Unicode BOM.Any of the kUniType... constants, except Auto,Character,Binary and the UTF32 values kUniTypeAnsiArabic kUniTypeAnsiBaltic kUniTypeAnsiCentralEuropean kUniTypeAnsiCyrillic kUniTypeAnsiGreek kUniTypeAnsiHebrew kUniTypeAnsiLatin1 kUniTypeAnsiThai kUniTypeAnsiTurkish kUniTypeAnsiVietnamese kUniTypeISO8859_1 kUniTypeISO8859_10 kUniTypeISO8859_11 kUniTypeISO8859_13 kUniTypeISO8859_14 kUniTypeISO8859_15 kUniTypeISO8859_16 kUniTypeISO8859_2 kUniTypeISO8859_3 kUniTypeISO8859_4 kUniTypeISO8859_5 kUniTypeISO8859_6 kUniTypeISO8859_7 kUniTypeISO8859_8 kUniTypeISO8859_9 kUniTypeNativeCharacters kUniTypeOEM kUniTypeUTF16 kUniTypeUTF16BE kUniTypeUTF16LE kUniTypeUTF8 |
| $istext | If true,the report output will be text based |
| $javascripttheme | The name of the current JavaScript client theme.Lower case.The html/themes folder must contain a JavaScript client theme file named <$javascripttheme>.json |
| $keys | A row of information that configures the keyboard sequences used for some parts of the environment |
| $language | The name of the language that Omnis is currently using (one of the languages stored in the localisation data file) |
| $linesperinch | Lines per inch when printing to a text device |
| $linesperpage | Number of lines per page when printing to text device and $generatepages is true |
| $listsearchtimeout | This property applies when $root.$prefs.$oldlistsearching is kFalse.The maximum duration (in 1/60th second units) between keys when searching a list.When this timeout occurs,Omnis empties the list search buffer.The minimum value is 30 |
| $macosdestname | macOS printer destination file path. The pathname of the output file when $macosdesttype is kPDF or kPostScript |
| $macosdesttype | macOS printer destination.A constant:kPrinter,kPDF or kPostScript.If the report destination is printer,and the job setup dialog is not opened,the constant specifies the actual destination.For file destinations,$macosdestname is the path kPDF kPostScript kPrinter |
| $macosvalidatepapersize | If true,when printing on macOS,Omnis uses the macOS printing subsystem to check that the paper size is valid for the printer.If validation fails,the printing subsystem replaces the paper size for printing with a valid paper size |
| $mapdmltodam | The DML emulation mode used when $clib.$prefs.$dmlemulation is kTrue. |
| $maxcachedclasses | The maximum number of classes that Omnis caches in memory |
| $minimizeiconid | The id of the icon used when the application is minimized;on some platforms,this icon is also displayed in the application window title bar |
| $mousewheellines | The number of scroll lines scrolled by a single movement of the mouse wheel (clicking once on a scroll arrow scrolls by one scroll line) |
| $noomnisdata | If true, access to Omnis data files is prevented by the serial number |
| $odbserver | The TCP/IP address and port number of the Omnis Data Bridge (ODB) server,in the form address:port.The value of $odbserver is stored in the file odb.txt in the studio folder |
| $oldlisthiliting | If true, objects always use the same colors for hiliting,irrespective of whether or not they have the focus. If false,the hilite colors depend on whether or not the object has the focus (Windows and Linux only) |
| $oldlistsearching | If true,list keyboard searching behaves like Omnis Studio 4.3.x and earlier: '+' and '-' go to the next and previous match respectively, and the search buffer does not automatically clear when entry stops |
| $orientation | The paper orientation kOrientDefault kOrientLandscape kOrientPortrait |
| $pages | The pages to be printed (empty=all) |
| $pagesetupdata | The report page setup data |
| $paper | The paper type kPa10X11 kPa10X14 kPa11X17 kPa15X11 kPa9X11 kPaA2 kPaA3 kPaA3Extra kPaA3ExtraTrans kPaA3Trans kPaA4 kPaA4Extra kPaA4Plus kPaA4Small kPaA4Trans kPaA5 kPaA5Extra kPaA5Trans kPaA6 kPaAPlus kPaB4 kPaB5 kPaB5Extra kPaB5Trans kPaBPlus kPaCSheet kPaCustom kPaDefault kPaDSheet kPaEnv10 kPaEnv11 kPaEnv12 kPaEnv14 kPaEnv9 kPaEnvB4 kPaEnvB5 kPaEnvB6 kPaEnvC3 kPaEnvC4 kPaEnvC5 kPaEnvC6 kPaEnvC65 kPaEnvDL kPaEnvInvite kPaEnvItaly kPaEnvMonarch kPaEnvPersonal kPaESheet kPaExecutive kPaFanfoldLglGer kPaFanfoldStdGer kPaFanfoldUs kPaFolio kPaIsoB4 kPaIWComputerPaper kPaIWInternationalFanfold kPaJapPostcard kPaLedger kPaNote kPaQuarto kPaStatement kPaTabloid kPaTabloidExtra kPaTSP600LongReceipt kPaTSP600Receipt kPaUsLegal kPaUsLegalExtra kPaUsLetter kPaUsLetterExtra kPaUsLetterExtraTrans kPaUsLetterPlus kPaUsLetterSmall kPaUsLetterTrans |
| $paperlength | The length of the paper |
| $paperwidth | The width of the paper |
| $portdatabits | The port data bits (7 or 8) kPort7DataBits kPort8DataBits |
| $porthandshake | The port handshake (none,xon/xoff,hardware) kPortHardware kPortNoHandshake kPortXonXoff |
| $portname | The name of the port |
| $portparity | The port parity (none,odd,even) kPortEvenParity kPortNoParity kPortOddParity |
| $portprofile | The name of the Port Profile that is to be used |
| $portspeed | The port baud rate |
| $portstopbits | The port stop bits (1 or 2) kPort1StopBit kPort2StopBits |
| $printernotify | A kPrt... constant that specifies what occurs when another application changes the default printer (Windows only) kPrtNoteAuto kPrtNoteMsg kPrtNoteNoMsg |
| $printfile | The print file name for printing reports to a file |
| $promptforreorg | If true, Omnis prompts to reorganize the data file upon closing the file class editor |
| $reportdataname | The variable to receive report data when printing to memory |
| $reportfield | The hwnd to which to send the screen or preview report |
| $reportfile | The report file name for saving reports to disk.If the report destination is the Omnis PDF device then this is the path of the output PDF;when empty the PDF device will prompt the user for the path if it is not running in a server thread |
| $reporttoolbarpagepreview | A sum of kRB... constants which identify the toolbar buttons on user (non-IDE) page preview windows.kRBpagePreview is not supported for page preview windows.Changing this property does not affect open page preview windows |
| $restfulconnection | [POOL,][IPADDR:][PORT].Controls how the Omnis RESTful Web Server plugin connects to Omnis.POOL is a load sharing process pool name;IPADDR and PORT identify Omnis or load sharing process;if empty,defaults to $serverport |
| $restfulurl | The base URL used to call Omnis RESTful Web Services,e.g.http://www.test.com/scripts/omnisrestisapi.dll.Omnis uses this in the OpenAPI and Swagger definitions it generates.If empty,Omnis uses http://127.0.0.1:$serverport |
| $restrictpagewidth | If true,and printing to text device,page width is restricted |
| $scale | The scaling factor in percent |
| $sendformfeed | If true,and $generatepages is true,form feeds are sent to the device |
| $serverport | The TCP/IP port number (1-65535),or service name,on which the Omnis Server listens for connections |
| $serverstacks | The number of threaded stacks set up by the Start server command |
| $showremotedebugmenu | If true,the menu bar contains the remote debug menu. This property defaults to false,and is not saved with the configuration |
| $showsystemfocus | If true,a standard focus ring can be drawn around the control which has the focus (macOS only). See also the control property $disablesystemfocus |
| $showtoolbartips | If true,tooltips are displayed on toolbars. If false,no tooltips are displayed on any toolbars,irrespective of any other tooltip related settings |
| $showwindowtips | If true,tooltips are displayed on windows. If false,no tooltips are displayed on any windows,irrespective of any other tooltip related settings |
| $singleinstance | If true,only one instance of Omnis will be available (Microsoft Windows platforms only) |
| $taskbar | The position of the task bar on the main window (Microsoft Windows platforms only) kTaskbarBottom kTaskbarNone kTaskbarTop |
| $timeslice | The duration (in 1/60th second units) of the execution time slice for a server thread |
| $tokenizeexternalfieldnames | If true,Omnis uses tokens rather than text when tokenizing external field names |
| $tokenizeexternalfilenames | If true,Omnis uses tokens rather than text when tokenizing external file names |
| $usecms | If true, Omnis uses centimetres for report measurements;if false,Omnis uses inches |
| $waitforuser | If true,method execution is halted until screen/preview report is closed |
| $webbrowser | The pathname of the Web Browser used for local testing of JavaScript client remote forms,and OAUTH2 authorization flows that require a Web Browser. Leave blank to use the system default |
| $webserviceconnection | [POOL,][IPADDR:][PORT].Controls how the WSDL Web Service Web Server plugin connects to Omnis.POOL is a load sharing process pool name;IPADDR and PORT identify Omnis or load sharing process;if empty,defaults to 127.0.0.1:$serverport |
| $webservicelogging | A kWSL... constant that controls how the Omnis WSDL Web Service Server logs requests:kWSLOff for no logging,kWSLFaults to log SOAP faults only,kWSLFull to log all requests. See also the library preference $disablewebservicelogging kWSLFaults kWSLFull kWSLOff |
| $webservicelogmaxrecords | The maximum number of records allowed in the WSDL Web Service request log;once reached,the server deletes the oldest record before inserting a new record.Setting a new value deletes records if the new limit is exceeded |
| $webservicestrictwsdl | If true,Web Service WSDLs are strict (types are qualified with schema restrictions where possible,and annotations can be added to schema types).Set this to false if your client objects to this additional information in the WSDL |
| $webserviceurl | The URL used to call Omnis WSDL Web Services,e.g.http://www.test.com/scripts/owsisapi.dll.Omnis uses this in the WSDL files it generates.If empty,Omnis writes http://127.0.0.1:$serverport to WSDL files (use empty for local testing) |
| $windowoptions | A row of information that configures the appearance of top-level windows in the IDE (Microsoft Windows platforms only) |
| $windowprefs | Position and initial zoom factor for preview windows (Title[/ZOOM=n][/left/top/width/height/CEN/MAX/STK]) |
| $getconfigjson | $getconfigjson([bBaseConfig=kFalse]) Returns userconfig.json as a row (empty if userconfig.json could not be parsed). If bBaseConfig is kTrue, returns config.json instead. |
| $getconfiglong | $getconfiglong(iToolId,iItem,iDefault[,bScreenSpecific=kFalse]) Returns integer configuration item identified by iItem;if item is not in omnis.cfg,returns iDefault.bScreenSpecific kTrue means each screen layout can have a different value. iToolId identifies the tool, e.g. kEnvToolAddOn. See $installtool() in $root.$modes for details on valid item numbers for add-on tools. |
| $getconfigstring | $getconfigstring(iToolId,iItem,cDefault) Returns string configuration item identified by iItem; if item is not in omnis.cfg,returns cDefault. iToolId identifies the tool, e.g. kEnvToolAddOn. See $installtool() in $root.$modes for details on valid item numbers for add-on tools. |
| $openwebservicelog | $openwebservicelog() Opens the window to view the Web Service request log |
| $separators | $separators([cSeps]) gets or sets the sep chars for the current thread as a 5 char string (dp,thou,func,imdp,imsep);omit argument to return current seps or pass argument to set seps.func and imsep are only set if running in the main thread Character 1 (dp): the decimal point character Character 2 (thou): the decimal number thousands separator Character 3 (func): the function parameter separator Character 4 (imdp): the import/export decimal point character Character 5 (imsep): the import/export comma delimiter character |
| $serialise | $serialise([bGenericLogo=kFalse,cTitle,iIconId=0]) opens the serialize dialog;cTitle is the dialog title.If bGenericLogo is true a generic logo icon is displayed,else iIconId is the icon id of the logo icon (zero uses the default Omnis logo) |
| $setconfigjson | $setconfigjson(wConfigJson[, bBaseConfig=kFalse]) Sets userconfig.json to the supplied row. If bBaseConfig is kTrue, sets config.json instead. |
| $setconfiglong | $setconfiglong(iToolId,iItem,iValue[,bDosave=kFalse,bScreenSpecific=kFalse]) sets integer configuration item identified by iItem to iValue; if bDosave is true,Omnis saves omnis.cfg to disk after setting the value. iToolId identifies the tool, e.g. kEnvToolAddOn. See $installtool() in $root.$modes for details on valid item numbers for add-on tools. |
| $setconfigstring | $setconfigstring(iToolId,iItem,cValue[,bDosave=kFalse]) sets string configuration item identified by iItem to cValue;if bDosave is true,Omnis saves omnis.cfg to disk after setting the value. iToolId identifies the tool, e.g. kEnvToolAddOn. See $installtool() in $root.$modes for details on valid item numbers for add-on tools. |
| $dockingareas |