Vcl.ExtCtrls.TCustomControlBar.DoBandPaint

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DoBandPaint(Control: TControl; Canvas: TCanvas; var ARect: TRect;
var Options: TBandPaintOptions); virtual;

C++

virtual void __fastcall DoBandPaint(Vcl::Controls::TControl* Control, Vcl::Graphics::TCanvas* Canvas, System::Types::TRect &ARect, TBandPaintOptions &Options);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
Vcl.ExtCtrls.pas
Vcl.ExtCtrls.hpp
Vcl.ExtCtrls TCustomControlBar

Description

Generates an OnBandPaint event.

Do not call DoBandPaint. It is called automatically for each band when the control bar is painted. Override DoBandPaint to provide class-specific paint code for the bands or to suppress the OnBandPaint event.

Control is the control (usually a tool bar) whose band is about to be painted.

Canvas is the control bar's canvas. This is the canvas to use for drawing the band.

ARect is the dimensions of the band on the canvas. The OnBandPaint event handler can change this value to alter where the frame and grabber are drawn.

Options specifies which parts of the band should be drawn after DoBandPaint exits.

See Also