Sign in Join
FPDoc Onlineexperiment

TCustomTabControl.OnGetImageIndex property

Member of TCustomTabControlpublicIn unit ComCtrls

Event handler signalled to get the image index for a tab on the tabbed control.

Declaration

pascal
property OnGetImageIndex: TTabGetImageEvent read FOnGetImageIndex write FOnGetImageIndex;

Description

OnGetImageIndex is a TTabGetImageEvent property with the event handler signalled to get the ordinal position for the image displayed for the specified tab. It is signalled (when assigned) from the GetImageIndex method, and allows the application to override the value assigned to the ImageIndex property in a page object (TCustomPage).

The Sender argument is the object (TCustomTabControl) for the event notification.

TabIndex contains the ordinal position for a tab/page which is visible on the tabbed control.

ImageIndex is a variable argument used to return the position in Images for the bitmap displayed on the specified tab. Return -1 in the argument value if an image is not available in Images or not needed for the tab.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.