Sign in Join
FPDoc Onlineexperiment

TTreeNodes.InternalAddObject function

Member of TTreeNodesprotectedIn unit ComCtrls

Creates or updates a tree node with the specified text and a pointer to data.

Declaration

pascal
function InternalAddObject(Node: TTreeNode; const S: string; 
 Data: Pointer; AddMode: TAddMode): TTreeNode

Arguments

Node

An existing tree node to update, or Nil to create a new tree node.

S

Text for the tree node.

Data

Pointer to the data for the tree node.

AddMode

Position in the tree hierarchy where the node is stored.

Function result

TTreeNode instance created or updated in the method.

Description

Expands the parent for the Node (when assigned). Updates the accessibility role, description, and value when enabled in the tree view which owns the container. Updates the scroll bars for the tree view control prior to exit.

Used in the implementation of methods like: AddNode, AddObject, Insert, AddChildObject, et. al.

Errors

Raises an ETreeNodeError exception if the Owner for the container (the tree view control) has not been assigned.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.