Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
desktop:treeview [2019/06/06 22:56]
agcyphers [Properties]
desktop:treeview [2019/10/23 05:53] (current)
Line 33: Line 33:
 | AddNode( ParentNode as GraffitiTreeViewNode,​ NewNode as GraffitiTreeViewNode ) | See AddChildNode. | | AddNode( ParentNode as GraffitiTreeViewNode,​ NewNode as GraffitiTreeViewNode ) | See AddChildNode. |
 | CollapseNode( theNode as GraffitiTreeViewNode ) | Collapse a TreeViewNode to hide all children. | | CollapseNode( theNode as GraffitiTreeViewNode ) | Collapse a TreeViewNode to hide all children. |
-| CollapseNode( theNodeText as [[http://​developer.xojo.com/​string|String]] ) | ::: |+| CollapseNode( theNodeText as String ) | ::: |
 | EditCurrentNode() | Shows the editor for the currently selected node. | | EditCurrentNode() | Shows the editor for the currently selected node. |
 | EditNode( theNode as GraffitiTreeViewNode ) | Shows the editor for the specified node. | | EditNode( theNode as GraffitiTreeViewNode ) | Shows the editor for the specified node. |
 | ExpandNode( theNode as GraffitiTreeViewNode ) | Expands a node to show its children. | | ExpandNode( theNode as GraffitiTreeViewNode ) | Expands a node to show its children. |
-| ExpandNode( theNodeText as [[http://​developer.xojo.com/​string|String]] ) | ::: |+| ExpandNode( theNodeText as String ) | ::: |
 | GetCheckedNodes() as GraffitiTreeViewNode() | Returns an array of GraffitiTreeViewNodes that have a true boolean value. | | GetCheckedNodes() as GraffitiTreeViewNode() | Returns an array of GraffitiTreeViewNodes that have a true boolean value. |
 | GetNodeByTag( theTag as Variant ) as GraffitiTreeViewNode | Returns the first node with a tag matching theTag. | | GetNodeByTag( theTag as Variant ) as GraffitiTreeViewNode | Returns the first node with a tag matching theTag. |
 | GetNodeByText( theText as Variant ) as GraffitiTreeViewNode | Returns the first node with the specified text. | | GetNodeByText( theText as Variant ) as GraffitiTreeViewNode | Returns the first node with the specified text. |
-| GetNodeFromXY( X as [[http://​developer.xojo.com/​integer|Integer]], Y as [[http://​developer.xojo.com/​integer|Integer]] ) as GraffitiTreeViewNode | Returns the node at the specified display coordinates. | +| GetNodeFromXY( X as Integer, Y as Integer ) as GraffitiTreeViewNode | Returns the node at the specified display coordinates. | 
-| GetNodeFromY( Y as [[http://​developer.xojo.com/​integer|Integer]] ) as GraffitiTreeViewNode | Returns the node at the specified Y coordinate. | +| GetNodeFromY( Y as Integer ) as GraffitiTreeViewNode | Returns the node at the specified Y coordinate. | 
-| GetSelectedNodes( Y as [[http://​developer.xojo.com/​integer|Integer]] ) as GraffitiTreeViewNode() | Returns all currently selected nodes. | +| GetSelectedNodes( Y as Integer ) as GraffitiTreeViewNode() | Returns all currently selected nodes. | 
-| GetVisibleNodeByText( theText as [[http://​developer.xojo.com/​string|String]] ) as GraffitiTreeViewNode | Returns the currently visible node with theText. | +| GetVisibleNodeByText( theText as String ) as GraffitiTreeViewNode | Returns the currently visible node with theText. | 
-| InsertNode( Position as [[http://​developer.xojo.com/​integer|Integer]], NewNode as GraffitiTreeViewNode,​ ParentNode as GraffitiTreeViewNode = Nil ) | Inserts NewNode in to the node array, or ParentNode'​s child array, as Position. |+| InsertNode( Position as Integer, NewNode as GraffitiTreeViewNode,​ ParentNode as GraffitiTreeViewNode = Nil ) | Inserts NewNode in to the node array, or ParentNode'​s child array, as Position. |
 | RemoveAllNodes( fromNode as GraffitiTreeViewNode = Nil) | Removes all nodes from either the node array or fromNode'​s child array. | | RemoveAllNodes( fromNode as GraffitiTreeViewNode = Nil) | Removes all nodes from either the node array or fromNode'​s child array. |
-| RemoveNode( theIndex as [[http://​developer.xojo.com/​integer|Integer]] ) | Removes the specified node.  If it is the child of another node, it is removed from that parent. ​ If it has children, all children are also removed. |+| RemoveNode( theIndex as Integer ) | Removes the specified node.  If it is the child of another node, it is removed from that parent. ​ If it has children, all children are also removed. |
 | RemoveNode( theNode as GraffitiTreeViewNode ) | ::: | | RemoveNode( theNode as GraffitiTreeViewNode ) | ::: |
 | ScrollTo( node as GraffitiTreeViewNode ) | Scrolls the display to the specified node. | | ScrollTo( node as GraffitiTreeViewNode ) | Scrolls the display to the specified node. |
 | SearchNodes(searchText as String, PartialMatch as Boolean = True) as GraffitiTreeViewNode | Searches node text for the specified string. | | SearchNodes(searchText as String, PartialMatch as Boolean = True) as GraffitiTreeViewNode | Searches node text for the specified string. |
-| SetNodeChecked( NodeTextOrTag as Variant, IsChecked as [[http://​developer.xojo.com/​boolean|Boolean]], IsText as [[http://​developer.xojo.com/​boolean|Boolean]] = True ) | Sets the checked value of the specified node.  If IsText = True, then NodeTextOrTag should be the node's text. | +| SetNodeChecked( NodeTextOrTag as Variant, IsChecked as Boolean, IsText as Boolean = True ) | Sets the checked value of the specified node.  If IsText = True, then NodeTextOrTag should be the node's text. | 
-| SetNodeNotifications( theIndex as [[http://​developer.xojo.com/​integer|Integer]], NotificationCount as [[http://​developer.xojo.com/​integer|Integer]] ) | Sets the notification display count on the node's icon.  If >10, an exclamation point is displayed. | +| SetNodeNotifications( theIndex as Integer, NotificationCount as Integer ) | Sets the notification display count on the node's icon.  If >10, an exclamation point is displayed. | 
-| SetNodeNotifications( theNode as GraffitiTreeViewNode,​ NotificationCount as [[http://​developer.xojo.com/​integer|Integer]] ) | ::: | +| SetNodeNotifications( theNode as GraffitiTreeViewNode,​ NotificationCount as Integer ) | ::: | 
-| SetNodeSelected( NodeTextOrTag as Variant, IsSelected as [[http://​developer.xojo.com/​boolean|Boolean]], IsText as [[http://​developer.xojo.com/​boolean|Boolean]] = True ) | Sets the selection of the specified node.  If IsText = True, then NodeTextOrTag should be the node's text. |+| SetNodeSelected( NodeTextOrTag as Variant, IsSelected as Boolean, IsText as Boolean = True ) | Sets the selection of the specified node.  If IsText = True, then NodeTextOrTag should be the node's text. |
  
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| AllowDeselect ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines if the user is allowed to deselect all nodes by clicking outside the rows. | +| AllowDeselect | Boolean | False | Determines if the user is allowed to deselect all nodes by clicking outside the rows. | 
-| BackgroundColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of the control. | +| BackgroundColor | Color | &​c000000 | Background color of the control. | 
-| BorderColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Border color of the control. | +| BorderColor | Color | &​c000000 | Border color of the control. | 
-| CanDrag ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether to enable functionality to drag nodes from the component to other controls. | +| CanDrag | Boolean | False | Determines whether to enable functionality to drag nodes from the component to other controls. | 
-| CheckColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color used to checkboxes. | +| CheckColor | Color | &​c000000 | Color used to checkboxes. | 
-| CheckHoverColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color used to draw checkboxes when the mouse if over them. | +| CheckHoverColor | Color | &​c000000 | Color used to draw checkboxes when the mouse if over them. | 
-| CheckSelectedColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color used to draw checkboxes with a state of True. | +| CheckSelectedColor | Color | &​c000000 | Color used to draw checkboxes with a state of True. | 
-| ColumnCount ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Number of columns. | +| ColumnCount | Integer | 0 | Number of columns. | 
-| ColumnWidths ​| [[http://​developer.xojo.com/​string|String]] | ""​ | String representing the columns widths. | +| ColumnWidths | String | ""​ | String representing the columns widths. | 
-| CustomColors ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If the control is to use the specified custom color properties. | +| CustomColors | Boolean | False | If the control is to use the specified custom color properties. | 
-| CustomPictures ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If the control is to use the specified custom picture properties. |+| CustomPictures | Boolean | False | If the control is to use the specified custom picture properties. |
 | Editor | TextField | Nil | TextField instance used for node editing. | | Editor | TextField | Nil | TextField instance used for node editing. |
-| ExpanderColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Default color for expanders when not hovered of selected. | +| ExpanderColor | Color | &​c000000 | Default color for expanders when not hovered of selected. | 
-| ExpanderHoverColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color for expanders when hovered. | +| ExpanderHoverColor | Color | &​c000000 | Color for expanders when hovered. | 
-| ExpanderSelectedColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color for expanders when the row is selected. | +| ExpanderSelectedColor | Color | &​c000000 | Color for expanders when the row is selected. | 
-| FullRowSelect ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Whether the control displays selections spanning the full row, or just the caption. | +| FullRowSelect | Boolean | False | Whether the control displays selections spanning the full row, or just the caption. | 
-| HasHeader ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Whether the control displays a large hearder. | +| HasHeader | Boolean | False | Whether the control displays a large hearder. | 
-| HeaderColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of the header. | +| HeaderColor | Color | &​c000000 | Background color of the header. | 
-| HeaderHeight ​| [[http://​developer.xojo.com/​integer|Integer]] | 32 | Height of the header. | +| HeaderHeight | Integer | 32 | Height of the header. | 
-| HeaderText ​| [[http://​developer.xojo.com/​string|String]] | ""​ | Text to displayed in the header. | +| HeaderText | String | ""​ | Text to displayed in the header. | 
-| HeaderTextColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of text in the header. | +| HeaderTextColor | Color | &​c000000 | Color of text in the header. | 
-| HeaderTextFont ​| [[http://​developer.xojo.com/​string|String]] | "​system"​ | Font of text in the header. | +| HeaderTextFont | String | "​system"​ | Font of text in the header. | 
-| HeaderTextSize ​| [[http://​developer.xojo.com/​integer|Integer]] | 16 | Size, in points, of the header text. | +| HeaderTextSize | Integer | 16 | Size, in points, of the header text. | 
-| IconChecked ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox with it's Value set to true. | +| IconChecked | Picture | Nil | Picture representation of node's checkbox with it's Value set to true. | 
-| IconCheckedHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox when hovered. | +| IconCheckedHover | Picture | Nil | Picture representation of node's checkbox when hovered. | 
-| IconCheckedSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox when the row is selected. | +| IconCheckedSelected | Picture | Nil | Picture representation of node's checkbox when the row is selected. | 
-| IconFolderCollapsed ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when collapsed. | +| IconFolderCollapsed | Picture | Nil | Picture representation of node's expander when collapsed. | 
-| IconFolderCollapsedHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when collapsed and hovered. | +| IconFolderCollapsedHover | Picture | Nil | Picture representation of node's expander when collapsed and hovered. | 
-| IconFolderCollapsedSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when collapsed and selected. | +| IconFolderCollapsedSelected | Picture | Nil | Picture representation of node's expander when collapsed and selected. | 
-| IconFolderExpanded ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when expanded. | +| IconFolderExpanded | Picture | Nil | Picture representation of node's expander when expanded. | 
-| IconFolderExpandedHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when expanded and hovered. | +| IconFolderExpandedHover | Picture | Nil | Picture representation of node's expander when expanded and hovered. | 
-| IconFolderExpandedSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's expander when expanded and selected.. | +| IconFolderExpandedSelected | Picture | Nil | Picture representation of node's expander when expanded and selected.. | 
-| IconRemove ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show for the remove action. | +| IconRemove | Picture | Nil | Picture to show for the remove action. | 
-| IconRemoveHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show when the remove button is hovered. | +| IconRemoveHover | Picture | Nil | Picture to show when the remove button is hovered. | 
-| IconRemoveSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show when the remove button'​s row is selected. | +| IconRemoveSelected | Picture | Nil | Picture to show when the remove button'​s row is selected. | 
-| IconReorder ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show for the reorder button. | +| IconReorder | Picture | Nil | Picture to show for the reorder button. | 
-| IconReorderHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show for the reorder button when hovered. | +| IconReorderHover | Picture | Nil | Picture to show for the reorder button when hovered. | 
-| IconReorderSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture to show for the reorder button when the row is selected. | +| IconReorderSelected | Picture | Nil | Picture to show for the reorder button when the row is selected. | 
-| IconUnchecked ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox with it's Value set to false. | +| IconUnchecked | Picture | Nil | Picture representation of node's checkbox with it's Value set to false. | 
-| IconUncheckedHover ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox with it's Value set to false and hoevered. | +| IconUncheckedHover | Picture | Nil | Picture representation of node's checkbox with it's Value set to false and hoevered. | 
-| IconUncheckedSelected ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Picture representation of node's checkbox with it's Value set to false and the row is selected. | +| IconUncheckedSelected | Picture | Nil | Picture representation of node's checkbox with it's Value set to false and the row is selected. | 
-| ListIndex ​| [[http://​developer.xojo.com/​integer|Integer]] | -1 | Current selection row index. | +| ListIndex | Integer | -1 | Current selection row index. | 
-| MultiSelect ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If a user may select more than one node/row. | +| MultiSelect | Boolean | False | If a user may select more than one node/row. | 
-| NotificationColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of notification icon. | +| NotificationColor | Color | &​c000000 | Background color of notification icon. | 
-| NotificationTextColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Text color of notification icon. | +| NotificationTextColor | Color | &​c000000 | Text color of notification icon. | 
-| RemoveColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of remove icon. | +| RemoveColor | Color | &​c000000 | Color of remove icon. | 
-| RemoveColorHover ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of remove icon when hovered. | +| RemoveColorHover | Color | &​c000000 | Color of remove icon when hovered. | 
-| RemoveColorSelected ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of remove icon when row selected. | +| RemoveColorSelected | Color | &​c000000 | Color of remove icon when row selected. | 
-| ReorderColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of reorder icon. | +| ReorderColor | Color | &​c000000 | Color of reorder icon. | 
-| ReorderColorHover ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of reorder icon when hovered. | +| ReorderColorHover | Color | &​c000000 | Color of reorder icon when hovered. | 
-| ReorderColorSelected ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of reorder icon when row selected. | +| ReorderColorSelected | Color | &​c000000 | Color of reorder icon when row selected. | 
-| RowColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of rows. | +| RowColor | Color | &​c000000 | Background color of rows. | 
-| RowColorAlt ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of alternating rows. | +| RowColorAlt | Color | &​c000000 | Background color of alternating rows. | 
-| RowHeight ​| [[http://​developer.xojo.com/​integer|Integer]] | 29 | Height of rows. | +| RowHeight | Integer | 29 | Height of rows. | 
-| RowHoverColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color when row is hovered. | +| RowHoverColor | Color | &​c000000 | Background color when row is hovered. | 
-| RowHoverTextColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Text color when row is hovered. | +| RowHoverTextColor | Color | &​c000000 | Text color when row is hovered. | 
-| RowTextColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Text color of rows. | +| RowTextColor | Color | &​c000000 | Text color of rows. | 
-| RowTextFont ​| [[http://​developer.xojo.com/​string|String]] | "​system"​ | Font used to display node captions. | +| RowTextFont | String | "​system"​ | Font used to display node captions. | 
-| RowTextSize ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Text size, in points, of nodes. |+| RowTextSize | Integer | 0 | Text size, in points, of nodes. |
 | ScrollMax | Integer (Read-Only) | 0 | Maximum scroll position. | | ScrollMax | Integer (Read-Only) | 0 | Maximum scroll position. |
-| ScrollPosition ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Current scroll position. | +| ScrollPosition | Integer | 0 | Current scroll position. | 
-| SelectedRowColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Background color of selected row. | +| SelectedRowColor | Color | &​c000000 | Background color of selected row. | 
-| SelectedRowTextColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Text color of selected row. |+| SelectedRowTextColor | Color | &​c000000 | Text color of selected row. |
 | ShowBorder | Boolean | True | When True, a border is drawn around the edge of the control. | | ShowBorder | Boolean | True | When True, a border is drawn around the edge of the control. |
 | Style | GraffitiTreeView.Styles | Modern | The style to apply to the tree's drawing. | | Style | GraffitiTreeView.Styles | Modern | The style to apply to the tree's drawing. |