$root.$prefs

The preference items.

Properties

$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
$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)
$balloonson If true, help balloons are switched on (macOS 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
$clientexeccolor The color used to display a method which will execute on the client
$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
$dockingareacolor Not supported on macOS. The color used to draw toolbar docking areas; kColorDefault causes the docking areas to be drawn using the default for the current platform
$dockingareatextcolor Not supported on macOS. The color used to draw button text in toolbar docking areas; kColorDefault causes the text to be drawn using the default for the current platform
$editionfile The edition file name for printing reports to publisher
$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 kUniTypeAnsiLatin1kUniTypeAnsiThai 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
$exportnullsasempty If true, Omnis exports NULLs as empty values in one field per line, tab and comma delimited exports
$flashdefaultbutton If true, the default button flashes (macOS and Windows Vista only). Use this preference to disable flashing if you need to maximize the CPU time available to other applications
$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 kUniTypeAnsiLatin1kUniTypeAnsiThai kUniTypeAnsiTurkish kUniTypeAnsiVietnamese kUniTypeISO8859_1 kUniTypeISO8859_10 kUniTypeISO8859_11 kUniTypeISO8859_13kUniTypeISO8859_14 kUniTypeISO8859_15 kUniTypeISO8859_16 kUniTypeISO8859_2 kUniTypeISO8859_3 kUniTypeISO8859_4 kUniTypeISO8859_5kUniTypeISO8859_6 kUniTypeISO8859_7 kUniTypeISO8859_8 kUniTypeISO8859_9 kUniTypeNativeCharacters kUniTypeOEM kUniTypeUTF16 kUniTypeUTF16BEkUniTypeUTF16LE kUniTypeUTF8
$inheritedcolor The color the IDE uses to display inherited objects, methods and properties
$istext If true, the report output will be text based
$javaoptions Use this property to specify any switches you wish to pass to the Java Virtual Machine, e.g. to set a system property value, set $javaoptions to -Dproperty=value
$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
$loadadhocs If true, Omnis is serialized to allow use of the Adhoc Reports library
$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
$nosetpropertycolor The color the property manager uses to display the name of the selected property when it cannot be set
$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
$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
$macosprintstatus If true, operating system print status windows are used during a print job on macOS
$macosvalidatepapersize If true, when printing on macOS, Omnis uses the macOS printing subsystem to ensure that the paper size is valid for the printer. If the validation fails, the printing subsystem replaces the paper size for printing with a valid paper size
$pages The pages to be printed (empty=all)
$pagesetupdata The report page setup data
$paper The paper type, one of the kPa… constants
$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
$reporttoolbarscreen A sum of kRB... constants which identify the toolbar buttons on user (non-IDE) screen report windows. kRBzoom is not supported for screen reports. Changing this property does not affect open screen reports
$reservesystemcolors (macOS only) If true, environment colors will be reserved
$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 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
$runtimepropertycolor The color used to display the name of a runtime property in the property inspector
$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-32767), or service name, on which the Omnis Server listens for connections
$serverstacks The number of threaded stacks set up by the Start server command
$setpropertycolor The color the property manager uses to display the name of the selected property when it can be set
$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 (Win32 only) If true, only one instance of Omnis will be available
$stickywindowmenubar (Mac 8.x only) If true, the behavior of all window menu bars is sticky
$style97 If true, parts of the user interface (e.g. menus and toolbars) take on a new appearance. Omnis only uses this value at startup
$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
$toolobjselectcolor The color used to highlight a selected, non-inherited, object in the toolbar editor, and selected status bar panes in the window editor
$usecms If true, Omnis uses centimetres for report measurements; if false, Omnis uses inches
$usejavaoptions If true, you can set $javaoptions to manually specify advanced Java options .If false, the $javaoptions properties are read-only, meaning that the Java Virtual Machine uses its default settings
$waitforuser If true, method execution is halted until screen/preview report is closed
$webbrowser The path name of the Web Browser for local testing of JavaScript client remote forms. Leave blank to use 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
$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)
$windowprefs Position for screen and preview windows (Title/left/top/width/height/STK/CEN)

Methods

$getconfiglong $getconfiglong(iToolId,iItemNumber,iDefaultValue) Returns the configuration item value identified by iItemNumber as a number; if the item is not present in omnis.cfg, it returns iDefaultValue. 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,iItemNumber,cDefaultValue) Returns the configuration item value identified by iItemNumber as a string; if the item is not present in omnis.cfg, it returns cDefaultValue. 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 separator chars for the current thread as a 5 char string (dp,thou,func,imdp,imsep); omit argument to return current separators or pass argument to set separators. 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)
$setconfiglong $setconfiglong(iToolId,iItemNumber,iValue[,bDosave=kFalse]) sets the configuration item value identified by iItemNumber to the number 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,iItemNumber,cValue[,bDosave=kFalse]) sets the configuration item value identified by iItemNumber to the string 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.

Children

$dockingareas