$root.$libs.LIB.$windows.WINDOW

Parent: $root.$libs.LIB.$windows

Instance notation

Properties

Object specific
$aligntogrid If true, fields are snapped to the grid when they are moved
$backgroundskin Icon ID of skin used for background
$backgroundskinalign Alignment of background skin picture kPALbottomCenter kPALbottomLeft kPALbottomRight kPALcenter kPALcenterLeft kPALcenterRight kPALtile kPALtopCenter kPALtopLeft kPALtopRight
$bringinfront If true, the window opens in front of palette style windows
$clickbehind If true, the window allows clicks to bring other windows to the front
$closebox If true, the window has a close box or system menu
$collectperformancedata This 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
$dockingedge The border style of the edge of the window docking area kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$enablemenuandtoolbars If true, all main toolbars and menus are enabled when this window is on top
$growbox If true, the window has a grow box or grow border
$hasmenus If true, the window has a menu bar
$hasstatusbar If true, the window has a status bar
$helpbutton If true, the window has a help button in the title bar. Applies to Windows 32 bit platforms only
$horzgrid The horizontal grid size
$inheritedorder The 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
$keepclicks If true, the window receives clicks which cause it to be brought to the front
$menuedge The border style of the edge of the menu kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$menunames The names of the menu classes used in the window menu bar
$minimizebox If true, the window has a minimize box
$minimizeiconid The id of the icon used when the window is minimized; on some platforms, this icon is also displayed in the window title bar
$modelessdata If true, the window is always in enter data mode
$pathname The path to the class in the folder tree
$showcommands If true, the window causes the commands menu to be installed
$showgrid If true, the window displays a dotted grid in design mode
$showtitle If true, the window displays a title
$sizetogrid If true, field sizes are restricted to being a multiple of the grid size
$startfield The ident or order number of the initial enterable field of the window
$statusbarpos A kSBPos... constant, which specifies the position of the window status bar when $hasstatusbar is kTrue kSBPosBottom kSBPosPlatformDefault kSBPosTop
$statusedge The border style of the edge of the status bar kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$style The window style kDialog kNoframe kPalette kSimple kTitle
$title The window title
$toolbarnames The names of the toolbar classes used in the window docking area
$toolbaroptions Set of toolbar options (e.g. kTBOptionShowText). Note that you can only assign this property when $toolbarpos is not kDockingAreaNone. Also note that kTBOptionOSXOmnisTopToolbar can only be toggled when designing a window
$toolbarpos The position of the toolbar in the window; this can be any of the kDockingArea... constants except kDockingAreaFloating
kDockingAreaBottom kDockingAreaLeft kDockingAreaNone kDockingAreaRight kDockingAreaTop
$usesheets If true, standard OK messages, file dialogs and working messages are opened as sheets on MacOS
$vertgrid The vertical grid size
$zoombox If true, the window has a zoom box or maximize box
Standard $alpha $backcolor $backgroundtheme $backpattern $classdata $classtype $componenticon $componenttype $contextmenu $createdate $desc$designtaskname $disksize $dropmode $edgefloat $effect $external $forecolor $height $helpfile $horzscroll $ident $issubwindow $issupercomponent$left $moddate $name $parentfolder $showascheckedout $superclass $top $userinfo $version $vertscroll $width

Methods

$clearperformancedata $clearperformancedata() Clears the performance data for all methods in the class
$findandreplace $findandreplace(cFind, cReplace [,bIgnoreCase=kTrue, bWholeWord=kFalse, bRegExp=kFalse, bClearLog=kFalse]) Replaces all instances in the class of cFind with cReplace. Returns a row of status information. bClearLog=kTrue clears the log first
$isa $isa(rClass) Returns true if the class or instance is a subclass of the specified class
$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([cInstName, iLocn=kWindowNormal, cons-params]) opens an instance of the window at location iLocn; cInstName = '*' means Omnis creates instance name. Passes cons-params to $construct. Returns item reference to window instance
$openmodal $openmodal([cInstName, iLocn=kWindowNormal, cons-params]) opens a modal instance of the window at location iLocn; cInstName = '*' means Omnis creates instance name. Passes cons-params to $construct. Returns item reference to window instance
$openonce $openonce([cInstName,iLocn=kWindowNormal,cons-params]) opens an instance of window, at location iLocn, if none is open; otherwise brings existing instance to front. cInstName = '*' means Omnis creates instance name. Passes cons-params to $construct. Returns item reference to window instance

Children

$bobjs $cvardefs $cvars $inheritedobjs
$insts $ivardefs $menus $methods
$objs $statusbar