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

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

Instance notation

Properties Methods 

Properties

Object specific 
$aligntogridIf true,fields are snapped to the grid when they are moved
$backgroundskinIcon ID of skin used for background
$backgroundskinalignAlignment of background skin picture
kPALbottomCenter kPALbottomLeft kPALbottomRight kPALcenter kPALcenterLeft kPALcenterRight kPALstretch kPALtile kPALtopCenter kPALtopLeft kPALtopRight
$bringinfrontIf true,the window opens in front of palette style windows
$clickbehindIf true,the window allows clicks to bring other windows to the front
$closeboxIf true,the window has a close box or system menu
$collectperformancedataThis 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
$designguidesA comma separated string of design guides. L25,T50 (left 25px,top 50px). Left top, right and bottom values supported.
$dockingedgeThe border style of the edge of the window docking area
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$editorThe name of the add-in tool library used to edit this class
$editordataEditor data stored with the class.Typically used by the library identified by $editor
$enablemenuandtoolbarsIf true,all main toolbars and menus are enabled when this window is on top
$growboxIf true,the window has a grow box or grow border
$hasmenusIf true, the window has a menu bar
$hasstatusbarIf true, the window has a status bar
$helpbuttonIf true,the window has a help button in the title bar. Applies to Windows 32 bit platforms only
$horzgridThe horizontal grid size
$inheritedorderThe 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
$keepclicksIf true,the window receives clicks which cause it to be brought to the front
$menuedgeThe border style of the edge of the menu
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$menunamesThe names of the menu classes used in the window menu bar
$minheightThe minimum value to which $height of the window can be set (either programmatically or by the user resizing the window). Zero means no minimum has been specified
$minimizeboxIf true,the window has a minimize box
$minimizeiconidThe id of the icon used when the window is minimized;on some platforms,this icon is also displayed in the window title bar
$minwidthThe minimum value to which $width of the window can be set (either programmatically or by the user resizing the window). Zero means no minimum has been specified
$modelessdataIf true,the window is always in enter data mode
$movebehindIf true,when the window is on top it allows mouse move events in other windows
$pathnameThe path to the class in the folder tree
$showcommandsIf true,the window causes the commands menu to be installed
$showgridIf true,the window displays a dotted grid in design mode
$showtitleIf true,the window displays a title
$sizetogridIf true,field sizes are restricted to being a multiple of the grid size
$startfieldThe ident or order number of the initial enterable field of the window
$statusbarposA kSBPos... constant, which specifies the position of the window status bar when $hasstatusbar is kTrue
kSBPosBottom kSBPosPlatformDefault kSBPosTop
$statusedgeThe border style of the edge of the status bar
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$styleThe window style
kDialog kNoframe kPalette kSimple kTitle
$titleThe window title
$toolbarnamesThe names of the toolbar classes used in the window docking area
$toolbaroptionsSet of toolbar options (e.g. kTBOptionShowText). Note that you can only assign this property when $toolbarpos is not kDockingAreaNone. Also note that kTBOptionmacOSOmnisTopToolbar can only be toggled when designing a window
$toolbarposThe position of the toolbar in the window; this can be any of the kDockingArea... constants except kDockingAreaFloating
kDockingAreaBottom kDockingAreaLeft kDockingAreaNone kDockingAreaRight kDockingAreaTop
$usesheetsIf true, standard OK messages, file dialogs and working messages are opened as sheets on macOS
$vertgridThe vertical grid size
$zoomboxIf true,the window has a zoom box or maximize box
Standard$alpha $backcolor $backgroundtheme $backpattern $canremotedebugwhenlocked $classdata $classtype $componenticon $componentinfo $componenttype $contextmenu $createdate $desc $designtaskname $disksize $dropmode $edgefloat $effect $external $forecolor $height $helpfile $horzscroll $ident $issubwindow $issupercomponent $left $moddate $name $osdropflags $parentfolder $showascheckedout $superclass $top $userinfo $vcsrevision $version $vertscroll $width

Methods

$clearperformancedata$clearperformancedata() Clears the performance data for all methods in the class
$findandreplace$findandreplace(cFind,cRep[,bIgnCase=kTrue,bWholeWord=kFalse,bRegExp=kFalse,bClearLog=kFalse,bReturnLog=kFalse]) If cRep is #NULL,finds all instances of cFind;otherwise,replaces all instances of cFind with cRep.Returns status row
$isa$isa(rClass|rExternalObject) Returns true if the class or instance is a subclass of the specified class or external object
$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,params...]) opens an instance of the window at iLocn;cInstName='*' means Omnis creates instance name.Passes params to $construct.First params entry can be parent window (kWindowSheet).Returns item ref to window.
$openmodal$openmodal([cInstName,iLocn=kWindowNormal,params...]) opens a modal instance of the window at location iLocn;cInstName = '*' means Omnis creates instance name.Passes parameters to $construct.Returns item reference to window instance
$openonce$openonce([cInstName,iLocn=kWindowNormal,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 parameters to $construct..Returns item reference to window instance
$removecodefolding$removecodefolding() Removes code folding from all methods in the class. Returns the number of methods from which code folding was removed

Children

Top 

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