Sign in Join
FPDoc Onlineexperiment

TTreeNode.DisplayTextLeft function

Member of TTreeNodepublicIn unit ComCtrls

Returns the position for the left edge of the text on the tree node.

Declaration

pascal
function DisplayTextLeft: Integer

Function result

Horizontal coordinate where the Text for the tree node is located.

Description

DisplayTextLeft is a method used to determine the horizontal coordinate where the Text for the tree node is displayed. If a TCustomTreeview instance has not been assigned in the tree node, the return value contains the result from the DisplayIconLeft method.

Values from the Images and GetImageSize in the TreeView control are used (when assigned) to adjust the left edge for the Text display area. If an image position has been assigned in ImageIndex or SelectedIndex, the left edge is increased by the image size and the default item spacing on the TreeView control.

DisplayTextLeft is used in TTreeNode methods like DisplayRect and DisplayTextRight. It is also used in TCustomTreeView methods including BeginEditing, GetHitTestInfoAt, and MouseDown.

See also

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