$root.$iwindows.WINDOW.$objs.BreadCrumb

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

Class notation

Properties Methods Events 

Properties

Object specific 
$activecrumbcolorThe color of the active breadcrumb. kColorDefault means use the activebreadcrumbcolor property in the breadcrumb section of appearance.json.
$activecrumbtextcolorThe text color of the active breadcrumb. kColorDefault means use the activebreadcrumbtextcolor property in the breadcrumb section of appearance.json.
$allowcopyIf true,when the field is active and disabled,the user can set focus to the field,select text with mouse or select all,and copy to clipboard.Note that the field does not generate click events when it is active,disabled and $allowcopy is kTrue
$contentsThe current contents of the object
$crumbcolorThe color of each breadcrumb in the path. kColorDefault means use the breadcrumbcolor property in the breadcrumb section of appearance.json
$crumboutlinecolorThe color used to outline a breadcrumb. kColorDefault means use the breadcrumboutlinecolor property in the breadcrumb section of appearance.json
$crumbstyleThe drawing style of the breadcrumb (a kBreadCrumbStyle... constant)
kBreadCrumbStyleArrow kBreadCrumbStyleRound kBreadCrumbStyleText
$disabledefaultcontextmenuIf true, the default context menu for the object will not be generated in response to a context click ($clib.$disabledefaultcontextmenu and $cobj.$disabledefaultcontextmenu must both be false for the menu to be generated)
$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
$homecrumbiconidThe icon id used for the home crumb
$homecrumbtextThe text shown on the home crumb
$showactivecrumbIf true,the active crumb (the final crumb on the path) is shown in the active color. See $activecrumbcolor
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
Standard$active $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $left $linestyle $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 
evBorderIconClickedSent to a field when the border icon is clicked
Parameters
pEventCodeThe event code
pLeftBorderIconkTrue if the left border icon was clicked
evGetTokenListSent to the token entry field when $tokenlist is not specified,to get the list of possible token values for the popup
Parameters
pEventCodeThe event code
pNewTextThe new text entered by the user
pTokenListThe list of possible token values to be displayed by the token entry popup.Assign this parameter when processing evGetTokenList
evTokensAddedIf the token entry field property $sendtokenevents is true, this event is sent to the token entry field when one or more tokens have been added
Parameters
pEventCodeThe event code
pTokenChangesThe list of added or deleted tokens.Two or three columns: name (token),display (display text) and optionally tag
evTokensDeletedIf the token entry field property $sendtokenevents is true, this event is sent to the token entry field when one or more tokens have been deleted
Parameters
pEventCodeThe event code
pTokenChangesThe list of added or deleted tokens.Two or three columns: name (token),display (display text) and optionally tag
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 evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop

Children

Top 

$methods