Sign in Join
FPDoc Onlineexperiment

TCustomTreeView.IsNodeHeightFullVisible function

Member of TCustomTreeViewprotectedIn unit ComCtrls

Indicates whether the full height for the specified tree node is visible on the tree view control.

Declaration

pascal
function IsNodeHeightFullVisible(ANode: TTreeNode): Boolean

Arguments

ANode

Tree node examined in the method.

Function result

True if the text for the specified tree node is fully visible within the vertical bounds for the control.

Description

IsNodeHeightFullVisible is a Boolean method which indicates whether the tree node in ANode is fully visible vertically on the tree view control.

The return value is True if the Top and Height properties for the tree node occur within the usable display area on the control.

The return value is False when:

  • The tree node in ANode has not been assigned (Nil).
  • The tree node and its Parent nodes are not Visible and/or Expanded.
  • The text displayed for the tree node is clipped (partially visible) at one of the vertical edges of the control.

IsNodeHeightFullVisible is used in the implementation of the IsNodeHeightFullVisible method in TTreeNode.

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