Sign in Join
FPDoc Onlineexperiment

TTreeNode.IndexOf function

Member of TTreeNodepublicIn unit ComCtrls

Get the index position for the specified child tree node.

Declaration

pascal
function IndexOf(AValue: TTreeNode): Integer

Arguments

AValue

Child node to locate in Items.

Function result

Ordinal position for the specified child node, or -1 when not a child node.

Description

The return value is -1 if the tree node in AValue is not a child node (its Parent node is not the current class instance). Calls GetIndex to calculate the position of the child node relative to previous sibling nodes. Roughly equivalent to calling IndexOf in the Items container, but using a TTreeNode search value instead of a String.

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