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

# TCustomPage

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

The base class for TTabSheet.

## Declaration

Source position: comctrls.pp line 236

`type TCustomPage = class(TWinControl)`
`protected`
`class procedure WSRegisterClass; override;` |  | Registers the widgetset class used for the class instance.
`procedure WMPaint(); message;` |  | Handles the LM_PAINT message for the control.
`procedure SetParent(); override;` |  | Sets the Parent control for the custom page.
`property Flags: TPageFlags; [rw]` |  | Contains flag values that represent the status or state for the handle in the custom page control.
`procedure CMHitTest(); message;` |  | Handles the CM_HITTEST control message.
`procedure CMVisibleChanged(); message;` |  | Handles the CM_VISIBLECHANGED message for the control.
`function GetPageIndex; virtual;` |  | Gets the value for the PageIndex property.
`procedure SetPageIndex(); virtual;` |  | Sets the value for the PageIndex property.
`function GetTabVisible; virtual;` |  | Gets the value for the TabVisible property.
`function DialogChar(); override;` |  | Provides support for a TCustomTabControl parent when handling a dialog accelerator key.
`procedure DoHide; virtual;` |  | Performs actions needed when Visible is changed to False.
`procedure DoShow; virtual;` |  | Performs actions needed when Visible is changed to True.
`procedure DestroyHandle; override;` |  | Updates the Flags property when the Handle for the control is freed.
`procedure RealSetText(); override;` |  | Notifies the widgetset to change the text for the control.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`function CanTab; override;` |  | Indicates if the Tab key can be used to navigate into or out of the control.
`function IsControlVisible; override;` |  | Indicates whether the control is visible.
`function HandleObjectShouldBeVisible; override;` |  | True if the control should be visible, unless it's being destroyed.
`function VisibleIndex; virtual;` |  | Gets the index number for a visible page within all of the visible pages.
`procedure CheckNewParent(); override;` |  | Ensures that the specified control is derived from TCustomTabControl.
`property PageIndex: Integer; [rw]` |  | Ordinal position for the page in the parent control.
`property TabVisible: Boolean; [rw]` |  | Indicates if the tab in the Parent control is visible.
`property ImageIndex: TImageIndex; [rw]` |  | Ordinal position for the image associated with the page.
`property Left: Integer; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property Top: Integer; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property Width: Integer; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property Height: Integer; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property TabOrder: TTabOrder; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property Visible: Boolean; [s]` |  | Not stored in LCL component streaming for TCustomPage.
`property OnHide: TNotifyEvent; [rw]` |  | Event handler signalled when the page is hidden.
`property OnShow: TNotifyEvent; [rw]` |  | Event handler signalled when the page becomes visible.
`end;`

## Inheritance

`TCustomPage` |  | The base class for TTabSheet.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TCustomPage is a TWinControl descendant which implements the base class for the tabbed pages found in notebooks. TCustomPage provides properties used to maintain the order and visibility of the page, and event handlers signalled when the page is hidden or displayed.

## See also

TTabSheet |  | An individual page used in TPageControl.
TPageControl |  | Implements a multi-page component with a series of tabs.
TCustomTabControl.Page |  | Provides indexed access to the page objects used on the tabbed control.
TCustomTabControl.ActivePageComponent |  | The active TCustomPage instance for the tabbed control.
Using Multi-Page Controls |  | MultiPageControls - controls that offer a selection of alternative pages for display.