TreeView Xojo plugin

DesktopTreeViewCustomNode Class



DesktopTreeViewCustomNode is a class to make custom rendered TreeView nodes and possibly with custom functionality.

Note:
You can inherit from the DesktopTreeViewCustomNode and add your own data properties to it. In fact the way to make your custom rendered node is to inherit from the TreeViewCustomNode class and hook your custom code into its events.

Warning:
A DesktopTreeViewCustomNode can not be reused in any way. This means that a node may not be put in two different DesktopTreeView controls or twice in the same unless if the node has first been removed from the TreeView that it was in.

No not use this class in non Desktop API project. If your project does not use the Desktop API where control are prefixed with Desktop then use the TreeViewCustomNode class.

TreeViewNode
   DesktopTreeViewCustomNode

class DesktopTreeViewCustomNode

Constructors

DesktopTreeViewCustomNodeA constructor that takes a text.
DesktopTreeViewCustomNodeA constructor that takes a text and a image.
DesktopTreeViewCustomNodeA constructor that takes text, image and dark mode image.

Properties

DarkModeImage (Inherited) Image to be used when in dark mode.
FontBold (Inherited) Set this property to true to let the node text be drawn bold faced.
FontItalic (Inherited) Set this property to true to let the node text be drawn italic faced.
FontUnderline (Inherited) Set this property to true to let the node text be drawn with text underline style.
HasExpander (Inherited) Use this property to force a node to have a expander even if it has no child nodes.
HasTextColor (Inherited) If set to true then TextColor property is active and will override Text color setting coming from the TreeView Control.
Image (Inherited) Sets or gets the node image.
ItemData (Inherited) A property to store custom data on the node.
Text (Inherited) Sets or gets the text of a node.
TextColor (Inherited) Sets the text color of a node.

Methods

AddSubItem (Inherited) Adds text to additional columns of the node.
AddSubItem (Inherited) Adds text and alignment to additional columns of the node.
AppendNode (Inherited) Appends a child node to the current node.
Depth (Inherited) Returns the depth of the node in the tree.
Expanded (Inherited) Returns true if the node is expanded.
GetTextOffset (Inherited) Returns x location where text starts to draw on a node, taking into account indents, expanders and icons.
Index (Inherited) Returns the Screen Index of the node.
IndexOf (Inherited) Finds a index of a child node relative to the parent.
InsertNode (Inherited) Inserts a child node at a given index to the current node.
ItemAlignment (Inherited) Sets or gets the alignment for a specific column.
ItemText (Inherited) Sets or gets the text for a specific column.
Node (Inherited) Returns a child node at a given index.
NodeCount (Inherited) Returns the count of child nodes.
RemoveChild (Inherited) Removes a child node.
RemoveChildAt (Inherited) Removes a child node at a index that is relative to the parent node.
Selected (Inherited) Returns true if the node is currently selected.
SetExpanded (Inherited) Expands or collapses the node.
SetItemIndent (Inherited) Sets Left or Right indent for the sub item
SortNodes (Inherited) Sorts children of the node, using compare delegate to compare the nodes.
Swap (Inherited) Swaps child nodes of the given node instance.

Events

DrawBackgroundDraws the background of a node.
DrawForegroundDraws the foreground of a node.
MouseDownThis Event is fired when mouse goes down in the custom node.
MouseDragThis Event is fired when mouse is dragged over the custom node after mouse has gone down there and true was returned from the mouse down event.
MouseUpThis Event is fired when mouse buttons goes up in the custom node after mouse has gone down there and true was returned from the mouse down event.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit