Sign in Join
FPDoc Onlineexperiment

TShellTreeView.OnCustomDrawItem property

Member of TShellTreeViewpublishedIn unit ShellCtrls

Event handler signalled to custom draw an item (tree node) on the control.

Declaration

pascal
property OnCustomDrawItem:;

Description

OnCustomDrawItem is a TTVCustomDrawItemEvent property with the event handler signalled to custom-draw the tree nodes displayed on the tree view control. OnCustomDrawItem is signalled from the CustomDrawItem method, and occurs during processing performed in the PaintNode method for the control.

Arguments to the event handler include:

Sender
The tree view control for the event notification.
Node
The TTreeNode instance with the node custom-drawn in the handler routine.
State
TCustomDrawState value with the drawing state for the tree node.
DefaultDraw
Variable Boolean argument used to indicate whether the PaintNode process can continue. Set to False in the handler routine to halt further paint operations for the tree node.

If either OnCustomDrawItem or OnAdvancedCustomDrawItem are assigned, the IsCustomDrawn method returns True.

This description is the one of ComCtrls.TCustomTreeView.OnCustomDrawItem.

See also

  • CustomDrawItem
  • OnAdvancedCustomDrawItem
  • IsCustomDrawn
  • DoPaintNode
  • DoPaint
  • Paint
  • TTreeNode
  • TTVCustomDrawItemEvent

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