Vcl.ComCtrls.TTabGetImageEvent

From RAD Studio API Documentation
Jump to: navigation, search

C++

typedef void __fastcall (__closure *TTabGetImageEvent)(System::TObject* Sender, int TabIndex, int &ImageIndex);

Properties

Type Visibility Source Unit Parent
typedef public Vcl.ComCtrls.hpp Vcl.ComCtrls Vcl.ComCtrls

Description

TTabGetImageEvent is the type of a tab control's TCustomTabControl.OnGetImageIndex and TTabControl.OnGetImageIndex event handlers.

Sender is the tab control in which an image is about to be displayed.

TabIndex is the index of the tab for which an image is about to be displayed.

ImageIndex is the index of the image to display in the tab.

Write an OnGetImageIndex event handler to specify the ImageIndex for a given TabIndex.

On entry to the event handler, the ImageIndex parameter is the same as the TabIndex parameter, where TabIndex is the index of the tab which is about to display its image. Change the ImageIndex parameter to specify the index into the Images property that specifies the image that should be painted.

See Also