Vcl.ComCtrls.TPageControl.GetImageIndex

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetImageIndex(TabIndex: Integer): Integer; override;

C++

virtual int __fastcall GetImageIndex(int TabIndex);

Properties

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

Description

Specifies the image to display for a particular page.

Override GetImageIndex in a derived class to specify the index of the image to display for a particular page.

TabIndex is the page's index that is about to be displayed.

The Return Value is an integer that is the image's index (in the Images property) that will be displayed in the tab.

By default, if there is no OnGetImageIndex event handler, GetImageIndex returns the ImageIndex property for the page with the specified index; otherwise, GetImageIndex calls the inherited GetImageIndex method, returning the result.

See Also