[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TCustomTabControl.PageToTabIndex

Maps a LCL page index to a tab index in the widgetset class.

Declaration

Source position: comctrls.pp line 485

public function TCustomTabControl.PageToTabIndex(

  AIndex: Integer

):Integer;

Arguments

AIndex

  

Ordinal position for the page object in the internal list.

Function result

Ordinal position for the page object in the list of visible tabs on the control.

Description

PageToTabIndex is an Integer function used to get the tab index for the specified page index. A page index is the physical location in the list of page objects. A tab index, on the other hand, is the logical position within the visible tabs on the tabbed control.

AIndex is the ordinal position in the page list for a tab, and is converted to the logical tab index in the return value. Values in AIndex must be in the range 0..PageCount-1.

The return value contains the position for the tab when only visible tabs are taken into consideration. In other words, the physical page index minus any preceding page objects with their TabVisible property set to False.

The return value is -1 when AIndex has a value less than 0 (zero) or greater than PageCount-1, or when the page object at the position in AIndex is not visible.

Remark: At design-time, all tabs are visible on the design surface for the tabbed control. The return value is set to the value in AIndex at design-time.

See also

TCustomTabControl.Page

  

Provides indexed access to the page objects used on the tabbed control.

TCustomTabControl.PageCount

  

Returns the number of page objects stored in the internal page list for the tabbed control.

TCustomPage.TabVisible

  

Indicates if the tab in the Parent control is visible.

TCustomPage.PageIndex

  

Ordinal position for the page in the parent control.


Version 4.0 Generated 2025-05-03 Home