Vcl.ComCtrls.TCustomListView.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 TCustomListView

Description

Determines when custom draw event handlers are called.

TCustomListView checks IsCustomDrawn to determine when to generate the OnCustomDraw, OnAdvancedCustomDraw, OnCustomDrawItem, OnAdvancedCustomDrawItem, OnCustomDrawSubItem, and OnAdvancedCustomDrawSubItem events. IsCustomDrawn returns true when the list view should generate an event.

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

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

See Also