$root.$iwindows.WINDOW.$objs.Tree List $root.$iwindows.WINDOW.$objs.Tree List
Parent: $root.$iwindows.WINDOW.$objs
Children
A tree list is a type of window field that provides a graphical way of displaying a hierarchy of items.
| Object specific | |
| $animateui | If the library preference $animateui is true, all objects that support $animateui will animate aspects of their interface. The object property only applies when the library preference is false. |
| $boldheader | If true, the heading has a bold font |
| $borderradius | Radius for rounded border corners.1 to 4 pixel values separated by -,in order topleft,topright,bottomright,bottomleft.If bottomleft is omitted it is topright.If bottomright is omitted it is topleft.If topright is omitted it is topleft |
| $buttonstyle | The drawing style of a button:kSystemButton,kUserButton,kNoBorderButton,kHeadingButton,kComboButton,kRoundButton,kLargeRoundButton, or kIDEButton.For headed and tree lists,it is the style of the header button: kSystemButton or kUserButton kSystemButton kUserButton |
| $canresizecolumns | If true, the user can use the mouse to resize the columns of the object |
| $colcount | Returns the number of columns in the list |
| $columnalignmode | Controls how $setcolumnalign affects the control. One of kAlignModeAll,kAlignModeBody, kAlignModeHeading and kAlignModeFooter kAlignModeAll kAlignModeBody kAlignModeFooter kAlignModeHeading kAlignModeNone |
| $columnnames | The names of the columns |
| $columnwidths | Comma separated list of column widths,expressed in pixels |
| $contentlinecolor | The color of lines drawn in the content of the control.kColorDefault means draw dotted lines.All other values mean draw single pixel lines of the specified color |
| $defaulticoncolor | The color used to draw the icon for the item, when the icon is a themed SVG icon and the $iconcolor property of the item is kColorDefault. If $defaulticoncolor is also kColorDefault, then the themed icon is drawn using the text color |
| $defaultnodeicon | The icon identifier used to reference the tree default node icon. See also $defaultnodeiconcolor |
| $defaultwidth | The default width of a column |
| $disableellipsis | If ($cobj.$disableellipsis|$clib.$prefs.$disableellipsis) window instance headed list boxes,and tree lists with more than one column,do not draw an ellipsis when the displayed value is truncated due to insufficient space |
| $disablehottracking | If true,the control does not draw any highlighting to show that the mouse is over the main body of the control but not pressed |
| $dropbetweenlines | If true, the object highlights between lines during drag and drop |
| $expandcollapseicon | The icon identifier used to reference the tree expand collapse icon |
| $fieldstylefocused | The style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus |
| $firstvis | The number of the first visible character or line in the contents |
| $gridsection | The type of the complex grid section containing the object. One of the kGrid... constants |
| $headerfillcolor | The fill color for the grid or headed list box header |
| $headerfontsize | The font size for the text in the header;if this is zero,the header text font size is $fontsize |
| $headertextcolor | The text color for the header |
| $hideheader | If true, the heading is hidden |
| $hilitecolumns | If true, additional columns in the tree are highlighted |
| $hiliteline | If true, the object highlights lines during drag and drop |
| $hot | A kHOT... constant that specifies the hot-tracking behaviour of the field kHOThot kHOTnotHot kHOTplatformDefault |
| $lastvis | The number of the final fully visible character or line in the contents |
| $linecount | The number of visible lines in the tree |
| $multipleselect | If true, the field allows the user to select more than one line |
| $nodeiconspos | A kIcon... constant that specifies the position of the node icons kIconOnLeft kIconOnNode kIconSystemSet |
| $selectionbackcolor | The color of selected lines. kColorDefault means use the default color. When not kColorDefault only applies when the control has the focus |
| $selectiontextcolor | The text color of selected lines. kColorDefault means use the default color. When not kColorDefault applies irrespective of whether the control has the focus |
| $showcolumnlines | If true, the control displays lines between columns |
| $showheaderlines | If true,the control displays lines between column headers |
| $showhorzlines | If true, the tree shows horizontal connecting lines |
| $shownodeicons | If true, the tree shows node icons |
| $showvertlines | If true, the tree shows vertical connecting lines |
| $studioide | If true,the control draws in a platform independent IDE style |
| $styledtext | If true, the field supports styled text. The text styles are stripped for objects on macOS style top toolbars,and for the menus created in place of lists to support vertical docking areas |
| $tooltippos | A kTooltipPos... constant that specifies where $tooltip appears relative to the control kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop |
| $treedefaultlines | The default lines with which the tree list will be populated |
| $treeindentlevel | The distance between tree indent levels |
| $treeleftmargin | The distance from the left that the tree will leave before drawing |
| $treelinehtextra | The extra vertical space to be added to each tree line |
| $treenodeiconmode | The node icons will change according to this state kNodeIconFixed kNodeIconLinkExpand kNodeIconLinkLine |
| $useiconsize | If true,the tree uses the icon size component of icons such as the defaultnodeicon. If false,the tree uses the default size of each icon |
| Standard | $active $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $disablefocus $disablefontsizekeys $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hscroll $hwnd $ident $keyevents $left $linestyle $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $vertscroll $visible $vscroll $width |
| Object specific | |
| $add | $add(cName[,iIdent,lRowForColumns]) adds a new root node to the tree |
| $clearallnodes | $clearallnodes() Clears all nodes below the node,or when called as a method of the tree object,all nodes in the tree |
| $collapse | $collapse() Collapses the nodes in the tree |
| $count | Returns the number of root nodes in the tree |
| $countall | $countall() Returns the total number of nodes in the tree |
| $currentnode | Returns an item reference to the currently selected node of the tree |
| $edittext | $edittext([iColumnNumber=1,bSetCurrentField=kFalse]) invokes in place text editing for the current node (or Column) of the tree,when the node (or column) is enterable,and the tree is the current field or bSetCurrentField is kTrue |
| $expand | $expand() Expands the nodes in the tree |
| $findnodeident | $findnodeident(rNoderef,iIdent[,bRecursive=kFalse]) Returns a node if $ident matches |
| $findnodename | $findnodename(rNoderef,cName[,bRecursive=kFalse,bIgnoreCase=kFalse]) Returns a node if $name matches |
| $findnodetag | $findnodetag(rNoderef,cTag[,bRecursive=kFalse]) Returns a node if $tag matches |
| $first | Returns an item reference to the first root node of the tree |
| $getcolumnalign | $getcolumnalign(iColumnNumber) gets the column alignment for the specified column |
| $getnodelist | $getnodelist(listmode,rNoderef,lListname) gets a nodes contents from the passed list |
| $getnodetooltip | $getnodetooltip(rNoderef) Called if $tooltip is empty,to get the tooltip to display when the mouse is over the node rNoderef.Returns either a styled text tooltip string,or an empty string (meaning use default) |
| $getselectednodes | $getselectednodes(&lList) gets a list of item references to the selected nodes in the tree |
| $getvisibleline | $getvisibleline(rItem) Returns the visible line number of the specified node |
| $getvisiblenode | $getvisiblenode(iVisLine) Returns an item reference to a tree node based on the visible line |
| $movenode | $movenode(rItem,rItemMoveAfter[,cChildModeConst]) moves rItem.rItem is moved according to kMoveNodexxx constants to .Returns kTrue if successful |
| $nextnode | $nextnode(rItem,bRecursive) Returns the next node in the tree |
| $prevnode | $prevnode(rItem,bRecursive) Returns the previous node in the tree |
| $remove | $remove(rItem) deletes the specified child node |
| $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 |
| $setcolumnalign | $setcolumnalign(iColumnNumber,[kLeftJst|kRightJst|kCenterJst]) sets the column alignment for the specified column |
| $setcurrentnode | $setcurrentnode(rNoderef) sets the current node to the referenced node |
| $setnodelist | $setnodelist(listmode,rNoderef,lListname) sets a nodes contents from the passed list |
| $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 | $addafter $addbefore $findident $findname $redraw |
| Object specific | |||||
| evWillHide | Sent to a field before it is hidden. Currently only used when the field is set as a side panel Parameters
| ||||
| evWillShow | Sent to a field before it becomes visible. Currently only used when the field is set as a side panel Parameters
| ||||
| Standard | evAfter evBefore evCanDrop evClick evDisabled evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evWillDrop |
| $methods |