$root.$iwindows.WINDOW.$objs.Navigation Menu

Parent: $root.$iwindows.WINDOW.$objs
 
Children 

Class notation

Properties Methods Events 

Properties

Object specific 
$borderedgesThe edges drawn as the border of the control. A sum of kNavMenuSide... constants
$borderwidthThe width (1-16) of the edges drawn as the border of the control
$cascadecontentsCan only be set,only applies when processing evLoadCascade.A list defining the content of the cascaded menu
$closeboxiconidThe id of the icon used to represent the close box on a cascaded menu (only relevant when $openwhenmouseover is kFalse,and the control is not in breadcrumb mode).Set to zero if no close box is required
$defaultcascadebackcolorThe default background color used to draw the background of a cascaded menu. Used when a background color is not specified in the row defining a cascaded menu
$defaultcascadebackpatternThe default pattern used to draw the background of a cascaded menu. Used when a background pattern is not specified in the row defining a cascaded menu
$defaultcascadebordercolorThe default color used to draw the border of a cascaded menu. Used when a border color is not specified in the row defining a cascaded menu
$defaultcascadeborderedgesThe default edges drawn as the border of a cascaded menu. Used when border edges are not specified in the row defining a cascaded menu. A sum of kNavMenuSide... constants
$defaultcascadeborderwidthThe default width (1-16) used for the edges drawn as the border of a cascaded menu. Used when a border width is not specified in the row defining a cascaded menu
$defaultcascadeflagsThe default flags used to control the opening of a cascaded menu. Used when no cascade flags are specified in the row defining a cascaded menu,or the cascade flags are kNavMenuCascadeFlagUseDefault
$defaultcascadeforecolorThe default foreground color used to draw the background of a cascaded menu. Used when a foreground color is not specified in the row defining a cascaded menu
$defaultcascadeopensideThe default side from which a cascaded menu will open. Used when a side is not specified in the row defining a cascaded menu
kNavMenuSideBottom kNavMenuSideLeft kNavMenuSideRight kNavMenuSideTop
$descriptionfontThe font used for entry descriptions
$descriptionfontsizeThe font size used for entry descriptions
$descriptionfontstyleThe style of the text in entry descriptions
$descriptiontextcolorThe color of the text in entry descriptions
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$headingfontThe font used for heading entries
$headingfontsizeThe font size used for heading entries
$headingfontstyleThe style of the text in heading entries
$headingtextcolorThe color of the text in heading entries
$horizontalcascadeiconidThe id of the icon used to indicate an entry that opens a cascaded menu horizontally
$horizontalspacingThe horizontal spacing used when laying out entries
$hotcloseboxiconidThe id of the icon used to represent the close box on a cascaded menu when the mouse is over the close box (only relevant when $openwhenmouseover is kFalse,and the control is not in breadcrumb mode)
$hotfontstyleThe style of enabled entry text when the mouse is over it or it has focus
$hotheadingfontstyleThe style of enabled heading text when the mouse is over it or it has focus
$hotheadingtextcolorThe color of enabled heading text when the mouse is over it or it has focus
$hottextcolorThe color of enabled entry text when the mouse is over it or it has focus
$openwhenmouseoverIf true,cascaded menus open when the mouse is over the relevant part of the control
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
$verticalcascadeiconidThe id of the icon used to indicate an entry that opens a cascaded menu vertically
$verticalspacingThe vertical spacing used when laying out entries
Standard$active $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentctrl $componentinfo $componentlib $componentvalid $container $contextmenu $cursor $dataname $defaultinactiveappearance $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $visible $width

Methods

Object specific 
$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
$showpanel$showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client
Standard$redraw

Events

Object specific 
evBrowserDownloadProgressSent to the control periodically while a download is in progress
Parameters
pEventCodeThe event code
pDownloadIdAn integer that identifies this download request
pTotalBytesExpectedThe total number of content bytes expected. -1 if the total is unknown
pBytesReceivedThe number of content bytes received so far
evBrowserFinishedDownloadSent to the control when a download has finished.pErrorText is empty if the file was successfully downloaded
Parameters
pEventCodeThe event code
pDownloadIdAn integer that identifies this download request
pErrorTextText describing the error
evBrowserFrameLoadErrorSent to the control when an error occurs while it is loading a frame
Parameters
pEventCodeThe event code
pUrlThe URL
pFrameThe browser frame. Empty means the main frame
pErrorTextText describing the error
evBrowserLoadStateChangeSent to the control when it starts or ends loading its content
Parameters
pEventCodeThe event code
pLoadingIf true,the control is loading content
evBrowserOpenUrlSent to the control when a navigation action by the user wants to open a URL in a new browser window
Parameters
pEventCodeThe event code
pUrlThe URL
evBrowserStartDownloadSent to the control before starting a file download.Your code must respond by calling either $startdownload() or $canceldownload()
Parameters
pEventCodeThe event code
pDownloadIdAn integer that identifies this download request
pSuggestedNameThe suggested name for the file
pMIMETypeThe MIME type of the file
pUrlThe URL
evCallMethodDoneSent to the control when a method invoked using $callmethod completes
Parameters
pEventCodeThe event code
pUniqueIdThe unique id that was returned by $callmethod(). This associates this event with the original call
pReturnThe return value of the control method. NULL if an error occurred - see pErrorText for details
pErrorTextText describing the error
evControlEventSent to the control when an event specific to an Omnis HTML control occurs
Parameters
pEventCodeThe event code
pInfoA row containing information about the event
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
StandardevAfter evBefore evCanDrop evClick evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evWillDrop

Children

Top 

$methods