Gets the ordinal position for the image displayed on the tab for the specified page.
Source position: comctrls.pp line 474
public function TCustomTabControl.GetImageIndex( |
ThePageIndex: Integer |
):Integer; virtual; |
ThePageIndex |
|
Ordinal position in Page with the image index for the tab. |
Ordinal position in Images for the specified page index.
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.
|
The current Page of the Notebook. |
|
|
PageIndex - Index number of the current page. |
|
|
Contains the ordinal position for the active Tab in the control. |
|
|
Images - the list of images associated with the pages of this notebook. |
|
|
OnGetImageIndex - event handler for getting an image index. |
|
|
Ordinal position for the image associated with the page. |