[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TCustomTreeView.PathDelimiter

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

Declaration

Source position: comctrls.pp line 3671

protected property TCustomTreeView.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.

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

Version info

Added in LCL version 3.0.

See also

TTreeNode.GetTextPath

  

Gets the hierarchical path to the tree node in the tree view.

TTreeNodes.FindNodeWithTextPath

  

Finds a node with the hierarchical path specified in TextPath.

TCustomShellTreeView

  

The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system.


Version 3.2 Generated 2024-02-25 Home