TTMSFNCTreeViewData Class
Stores and manages the nodes, columns, groups, filtering, sorting, selection, checking, and scrolling data used by a tree view.
API unit family: TMSFNCTreeViewData
Inherits from: TTMSFNCTreeViewBase
Implements: ITMSFNCBitmapContainer
Syntax
TTMSFNCTreeViewData = class(TTMSFNCTreeViewBase, ITMSFNCBitmapContainer)
Properties
| Name | Description |
|---|---|
| Filter | Gets the filter settings used to include or exclude nodes from the visible tree data. |
| SortMode | Gets the current node sorting mode. |
Methods
| Name | Description |
|---|---|
| AddNode | Adds a node under an optional parent node. |
| AddNodeToSelection | Adds a virtual node to the current selection. |
| AddVirtualNode | Adds a virtual node under an optional parent virtual node. |
| AfterExport | Restores the tree data state after export. |
| ApplyFilter | Applies the configured tree filter to the node data. |
| BeforeExport | Prepares the tree data for export. |
| CheckNode | Checks a node for a column. |
| CheckVirtualNode | Checks a virtual node for a column. |
| ClearColumns | Removes all column definitions from the tree data. |
| ClearNodeList | Clears the internal virtual-node list. |
| ClearNodes | Removes all nodes from the tree data. |
| CollapseAll | Collapses all regular nodes. |
| CollapseAllVirtual | Collapses all virtual nodes. |
| CollapseNode | Collapses a node. |
| CollapseVirtualNode | Collapses a virtual node. |
| CopyNode | Copies a node to another parent or position. |
| ExpandAll | Expands all regular nodes. |
| ExpandAllVirtual | Expands all virtual nodes. |
| ExpandNode | Expands a node. |
| ExpandVirtualNode | Expands a virtual node. |
| FindColumnByName | Finds a column by name. |
| FindColumnIndexByName | Finds the index of a column by name. |
| FindGroupByName | Finds a group by name. |
| FindGroupIndexByName | Finds the index of a group by name. |
| FindNodeByDBKey | Finds a node by database key. |
| FindNodeByRow | Finds a node by row index. |
| FindNodeByTextAndColumn | Finds a node by text in a column. |
| FindVirtualNodeByDBKey | Finds a virtual node by database key. |
| FindVirtualNodeByRow | Finds a virtual node by row index. |
| FindVirtualNodeByTextAndColumn | Finds a virtual node by text in a column. |
| GetFirstChildNode | Returns the first child node of ANode, or nil when ANode has no children. |
| GetFirstChildVirtualNode | Returns the first child virtual node of ANode, or nil when ANode has no children. |
| GetFirstRootNode | Returns the first root-level data node, or nil when the tree has no nodes. |
| GetFirstRootVirtualNode | Returns the first root-level virtual node, or nil when the visible list is empty. |
| GetLastChildNode | Returns the last child node of ANode, or nil when ANode has no children. |
| GetLastChildVirtualNode | Returns the last child virtual node of ANode, or nil when ANode has no children. |
| GetLastNode | Returns the last data node in document order, or nil when the tree has no nodes. |
| GetLastRootNode | Returns the last root-level data node, or nil when the tree has no nodes. |
| GetLastRootVirtualNode | Returns the last root-level virtual node, or nil when the visible list is empty. |
| GetLastVirtualNode | Returns the last virtual node in rendering order, or nil when the visible list is empty. |
| GetNextChildNode | Returns the child of ANode that follows AStartNode, or nil. |
| GetNextChildVirtualNode | Returns the child virtual node of ANode that follows AStartNode, or nil. |
| GetNextNode | Returns the node that follows ANode in document order, or nil when ANode is the last node. |
| GetNextSiblingNode | Returns the next sibling of ANode, or nil when ANode is the last child of its parent. |
| GetNextSiblingVirtualNode | Returns the next sibling virtual node of ANode, or nil when ANode is the last child of its parent. |
| GetNextVirtualNode | Returns the virtual node that follows ANode in rendering order, or nil when ANode is the last visible node. |
| GetNodeChildCount | Returns the number of direct child nodes of the specified node. |
| GetNodeForRow | Returns the virtual node at the specified row index, or nil when no node exists at that row. |
| GetNodeText | Returns the display text for a data node in the specified column. |
| GetNodeTitle | Returns the title text for a data node in the specified column. |
| GetParentNode | Returns the parent data node of the specified node, or nil for root-level nodes. |
| GetParentVirtualNode | Returns the parent virtual node of the specified virtual node, or nil for root-level nodes. |
| GetPreviousChildNode | Returns the child of ANode that precedes AStartNode, or nil. |
| GetPreviousChildVirtualNode | Returns the child virtual node of ANode that precedes AStartNode, or nil. |
| GetPreviousNode | Returns the node that precedes ANode in document order, or nil when ANode is the first node. |
| GetPreviousSiblingNode | Returns the previous sibling of ANode, or nil when ANode is the first child of its parent. |
| GetPreviousSiblingVirtualNode | Returns the previous sibling virtual node of ANode, or nil when ANode is the first child of its parent. |
| GetPreviousVirtualNode | Returns the virtual node that precedes ANode in rendering order, or nil when ANode is the first visible node. |
| GetRootNodeByIndex | Returns the root-level data node at the specified index, or nil when the index is out of range. |
| GetRootVirtualNodeByIndex | Returns the root-level virtual node at the specified index, or nil when the index is out of range. |
| GetTotalNodeCount | Returns the total number of data nodes across all levels of the tree. |
| GetTotalVirtualNodeCount | Returns the total number of virtual nodes in the current node structure. |
| GetVirtualNodeChildCount | Returns the number of direct child virtual nodes of the specified virtual node. |
| GetVirtualNodeText | Returns the display text for a virtual node in the specified column. |
| GetVirtualNodeTitle | Returns the title text for a virtual node in the specified column. |
| GetVirtualNodeTitleExpanded | Returns True when the title section for the specified virtual node and column is expanded. |
| InsertNode | Inserts a node at a specific position under an optional parent node. |
| InsertVirtualNode | Inserts a virtual node at a specific position under an optional parent virtual node. |
| IsColumnVisible | Returns whether a column is visible. |
| MoveNode | Moves a node to another parent or position. |
| RemoveFilter | Removes the active tree filter from the node data. |
| RemoveFilters | Clears all filter settings from the tree data. |
| RemoveNode | Removes a node and updates the tree data. |
| RemoveNodeChildren | Removes all child nodes from a node. |
| RemoveNodeFromSelection | Removes a virtual node from the current selection. |
| RemoveVirtualNode | Removes a virtual node and updates the tree data. |
| RemoveVirtualNodeChildren | Removes all child nodes from a virtual node. |
| ScrollToBottom | Scrolls to the bottom of the tree data. |
| ScrollToNode | Scrolls a node into view. |
| ScrollToTop | Scrolls to the top of the tree data. |
| ScrollToVirtualNode | Scrolls a virtual node into view. |
| ScrollToVirtualNodeInternal | Scrolls a virtual node into view using the internal scroll routine. |
| ScrollToVirtualNodeRow | Scrolls to the virtual node at a row index. |
| SetNodeCheckStates | Sets the checked state for all columns of a node at once. |
| SetNodeCheckTypes | Sets the check control type for all columns of a node at once. |
| SetNodeCollapsedIconNames | Assigns collapsed-state icon names for all columns of a node at once. |
| SetNodeCollapsedIcons | Assigns collapsed-state icons for all columns of a node at once. |
| SetNodeExpandedIconNames | Assigns expanded-state icon names for all columns of a node at once. |
| SetNodeExpandedIcons | Assigns expanded-state icons for all columns of a node at once. |
| SetNodeTextValues | Sets the cell text for all columns of a node at once. |
| ToggleCheckNode | Toggles the checked state of a node for a column. |
| ToggleCheckVirtualNode | Toggles the checked state of a virtual node for a column. |
| ToggleVirtualNode | Toggles the expanded state of a virtual node. |
| UnCheckNode | Unchecks a node for a column. |
| UnCheckVirtualNode | Unchecks a virtual node for a column. |