Sign in Join
FPDoc Onlineexperiment

TCustomTreeView.PathDelimiter property

Member of TCustomTreeViewprotectedIn unit ComCtrls

Delimiter used to separate node identifiers in the path to a given tree node.

Declaration

pascal
property PathDelimiter: string read FPathDelimiter write FPathDelimiter;

Description

PathDelimiter is a String property which contains the delimiter used between the identifiers for tree nodes in a given path. The default value for the property in TCustomTreeView is the '/' (Forward Slash) character.

PathDelimiter is used when a TTreeNode instance, owned by the tree view, build the path to the node in its GetTextPath method. If the path starts with the value in PathDelimiter, it represents the root for the tree. Every node in a tree is located in the hierarchy below the top level node '/'. The delimiter is appended after each ancestor node leading to the current tree node.

For example:

/node1
/node1/childnode1
/node1/childnode2
/node1/childnode3
/node2
/node3
//...

PathDelimiter is used in the FindNodeWithTextPath method in TTreeNodes when the node identifiers in a given path are examined and retrieved.

Please note that a different delimiter character may be used in descendent classes like TCustomShellTreeView.

Added in LCL version 3.0.

See also

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