Relationships

Represents a variety of relationships describing a node's location in a Tree. The following definitions should help you understand the meaning of Relationships properties:

  • Current node is the node being "measured".

  • Base node is the node relative to which the current node is measured.

  • Level is the shortest number of steps needed to get from a node to the tree root.

  • Relative level is the difference between the level of the current node and the level of the base node. If the base node is on level 3 and the current node is on level 5, then the current node's relative level is 2. If the base node is on level 5 and the current node is on level 5, then the current node's relative level is -2.

  • Distance is the number of steps between the current node and the base node. Distance can only be measured if the current node and base node are in the same line of descent (that is, if one is an ancestor/descendant of the other) or are identical. Distance is always either a positive number or 0.

  • Relative distance is similar to distance, but is a negative number if the current node is an ancestor of the base node.

  • The current and base nodes are siblings if they have the same parent node.

Relationships has the properties described in the following sections.