Sign in Join
FPDoc Onlineexperiment

TCustomTabControl.ActivePage property

Member of TCustomTabControlprotectedIn unit ComCtrls

Caption for the active page in the tabbed control.

Declaration

pascal
property ActivePage: string read GetActivePage write SetActivePage stored IsStoredActivePage;

Description

ActivePage is a String property which holds the caption for the active page in the control.

The property value is retrieved using values in the PageIndex and Page properties, and contains the Caption property for the TCustomPage instance. The property value is an empty string ('') if PageIndex is not in the range 0..PageCount-1.

Setting a new value for the property causes the indexed Page property to be searched to locate the TCustomPage instance with a Caption matching Value. If a page is found with the specified caption, the SetPageIndex method is called to validate and store the PageIndex, and signal the OnChange event handler when configured in Options. No actions are performed if the new property Value is not used in Page.

A value assigned to ActivePage at design-time is not stored in the LCL component streaming mechanism.

Use ActivePageComponent to read or write the TCustomPage instance that is the active page in the control.

Use Tabs to access the internal page (or tab) list for the control.

See also

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