TCustomTabControl.GetImageIndex function

Declaration

function GetImageIndex(ThePageIndex: Integer): Integer; virtual

Arguments

Function result

Ordinal position in Images for the specified page index.

Description

GetImageIndex is an Integer function used to get the ordinal position in Images for the image displayed on the specified tab. ThePageIndex contains the Page examined in the method to get its ImageIndex property. If Page does not have a TCustomPage instance at the position in ThePageIndex, -1 is used as the image index.

GetImageIndex signals the OnGetImageIndex event handler (when assigned) to allow a custom image index to be used in the return value.

GetImageIndex is called from methods in the widgetset class when the image displayed on a tab is needed.

See also

• Page
• PageIndex
• TabIndex
• Images
• OnGetImageIndex
• ImageIndex