$root.$iwindows.WINDOW

Parent: $root.$iwindows
 
Children 

Class notation

Properties Methods Events 

Properties

Object specific 
$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
$controlmethodThe control method
$dockingedgeThe border style of the edge of the window docking area
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$enablemenuandtoolbarsIf true,all main toolbars and menus are enabled when this window is on top
$enterableIf true, the window instance is in enterable mode
$fieldWhen used as a property of a subform instance or a subwindow instance, this is an item reference to the field in which the subform instance or subwindow instance is instantiated
$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
$inheritedUsed when referring to a method or variable defined in a superclass
$isdrawerIf true,the window for this instance is a drawer (macOS only). Deprecated.
$issheetIf true,the window for this instance is a sheet (macOS only)
$keepclicksIf true,the window receives clicks which cause it to be brought to the front
$maximizedIf true,the window has been maximized
$menuedgeThe border style of the edge of the menu
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$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
$minimizedIf true,the window has been minimized
$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
$norefreshIf true,screen updates to the window instance are disabled;the window instance will not draw until you set $norefresh to kFalse.Use this property to improve performance,for example when setting complex grid exceptions
$showcommandsIf true,the window causes the commands menu to be installed
$showtitleIf true,the window displays a title
$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
$toplevelhwndThe window identifier of the outer-most hwnd of the window instance. The properties of $toplevelhwnd are assignable. Set a reference to object.$toplevelhwnd.$ref, to access its properties
$usesheetsIf true, standard OK messages, file dialogs and working messages are opened as sheets on macOS
$zoomboxIf true,the window has a zoom box or maximize box
Standard$alpha $backcolor $backgroundtheme $backpattern $classdata $classtype $container $contextmenu $dropmode $edgefloat $forecolor $framehwnd $height $helpfile $horzscroll $hscroll $hwnd $ident $isprivate $left $name $osdropflags $top $vertscroll $visible $vscroll $width

Methods

Object specific 
$beginanimations$beginanimations(iDuration[,iCurve=kAnimationCurveEaseInOut]) after calling this,assignments to some properties are animated for iDuration milliseconds by $commitanimations()
$bringtofront$bringtofront([bRestoreIfMaximized=kFalse]) Bring the window instance to the front. If bRestoreIfMaximized is kTrue,also restore the window to its previous size and position if it is currently maximized
$commitanimations$commitanimations() animates the relevant property changes that have occurred after the matching call to $beginanimations()
$maximize$maximize() Maximize the window instance
$minimize$minimize() Minimize the window instance
$sendevent$sendevent(iEvent[,eventParameters...]) Sends event iEvent (an ev... constant value) to the object with eventParameters passed as name,value pairs, for example $sendevent(evClick,'pLineNumber',2).Returns kFalse if the event is discarded
$showmessage$showmessage(cMessage[,cTitle,iOptions=kMsgOK]) displays a message using the specified cMessage,cTitle and iOptions (a sum of kMsg... constants).Returns true for OK or Yes,false for No or cancel.Use msgcancelled() to check for cancel
$showtoast$showtoast(cMessage[,cTitle,iStyle=kToastSuccess,iStack=kToastStackTopRight,iTimer=4000,bClearStack=kFalse,cContext='']) displays a toast notification using the title and message using the style
Standard$canclose $close $redraw

Events

Object specific 
evAnimationsCompleteThe animations (started when $commitanimations was last called) have completed
Parameters
pEventCodeThe event code
evCancelSent to a window when an Cancel button or key is pressed
Parameters
pEventCodeThe event code
evCloseSent to a window when it is about to be closed
Parameters
pEventCodeThe event code
evCloseBoxSent to a window when its close box is clicked
Parameters
pEventCodeThe event code
evCustomMenuSent to the top window when a line on a custom menu is selected
Parameters
pEventCodeThe event code
pMenuLineA reference to the menu line which was selected
evMaximizedSent to a window when it has been maximized
Parameters
pEventCodeThe event code
evMinimizedSent to a window when it has been minimized
Parameters
pEventCodeThe event code
evMovedSent to a window when it has been moved
Parameters
pEventCodeThe event code
evOKSent to a window when an OK button or key is pressed
Parameters
pEventCodeThe event code
evResizedSent to a window when it has been resized
Parameters
pEventCodeThe event code
evRestoredSent to a window when it has been restored to its normal size
Parameters
pEventCodeThe event code
evStandardMenuSent to the top window when a line on a standard Omnis menu is selected
Parameters
pEventCodeThe event code
pCommandNumberThe Omnis command number selected from a built-in menu
evToolbarButtonSent to a window when its toolbar button is clicked (macOS only)
Parameters
pEventCodeThe event code
evToTopSent to a window when it becomes the top window
Parameters
pEventCodeThe event code
evWindowClickSent to the top window when another window is clicked
Parameters
pEventCodeThe event code
pClickedWindowA reference to the field or window which was clicked
pStayingBehindIf true,the window receiving the click will not come to the front as a result of the click (can only be true on macOS)
StandardevCanDrop evClick evDoubleClick evDrop evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp

Children

Top 

$bobjs$ivars$menus$methods
$objs$statusbar$toolbars$tvars