Vcl.ComCtrls.TCustomTreeView.IsCustomDrawn

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsCustomDrawn(Target: TCustomDrawTarget; Stage: TCustomDrawStage): Boolean; virtual;

C++

virtual bool __fastcall IsCustomDrawn(TCustomDrawTarget Target, TCustomDrawStage Stage);

Properties

Type Visibility Source Unit Parent
function protected
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TCustomTreeView

Description

Specifies when the control should generate custom draw events.

TCustomTreeView checks IsCustomDrawn to determine when to generate an OnCustomDraw, OnAdvancedCustomDraw, OnCustomDrawItem, or OnAdvancedCustomDrawItem event. IsCustomDrawn returns true when the tree view should generate an event.

The Target parameter indicates whether the tree view is about to draw the entire tree or about to draw a node. IsCustomDrawn does not return true unless the tree view has an appropriate event handler for the target.

The Stage parameter indicates the current stage in the process of painting the tree view. IsCustomDrawn returns true if the stage is cdPrePaint or if there is an advanced custom draw event handler for the target.

See Also