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

TPageControl

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

TPageControl - provides a series of tabs along the edge of a multi-page component, to allow selection of one of the pages (TTabSheet) of the component.

Declaration

Source position: comctrls.pp line 271

type TPageControl = class(TCustomNotebook)

  class procedure WSRegisterClass; override;

  

WSRegisterClass - Register this Class for the current Widget Set

protected

  procedure DoAddDockClient(); override;

  

DoAddDockClient creates a new TabSheet in the PageControl, places the client on it and aligns it

  procedure DockOver(); override;

  procedure DoRemoveDockClient(); override;

  

DoRemoveDockClient - frees the page which is being undocked

  function DoUndockClientMsg(); override;

  

Notifies the DockManager of the undock of a client control; always returns True.

  procedure DoChange; override;

public

  constructor Create(); override;

  

Create - constructor for TPageControl: sets PageClass to TTabSheet then calls inherited Create

  function FindNextPage();

  

FindNextPage - returns the next page (TTabSheet) in the sequence

  procedure SelectNextPage();

  

SelectNextPage - checking that its tab is visible

  property ActivePageIndex: Integer; [rw]

  

ActivePageIndex - index value of currently selected (active) page

  property Pages: TTabSheet; [r]

  

Pages - the actual Pages (TTabSheet) that comprise the component

published

  property ActivePage: TTabSheet; [rw]

  

ActivePage - the currently selected active page (TTabSheet)

  property OnGetDockCaption;

  

OnGetDockCaption - event handler to find the caption for the docked control

  property Align;

  

Used to align the control to the top, bottom, left or right of its client.

  property Anchors;

  

The set of anchor definitions for this control

  property BorderSpacing;

  

Determines the border spacing for this control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property DockSite;

  

Is this a dock site? (read/write, default is False)

  property DragCursor;

  

DragCursor - the style of cursor to be used during the Drag process

  property DragKind;

  

DragKind - what sort of dragging? Drag or Dock

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled (read/write). If not, it usually appears 'greyed-out'

  property Font;

  

The font to be used for text in this control (read/write).

  property Images;

  

Images - the list of images associated with the pages of this notebook

  property MultiLine;

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property ParentShowHint;

  

ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true

  property PopupMenu;

  

PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property ShowTabs;

  property TabIndex: Integer; [rw]

  

TabIndex - the Index value of the currently selected Tab

  property TabOrder;

  

The place this control occupies in the list of tabs

  property TabPosition;

  

TabPosition - top, bottom, left or right

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property Visible;

  

Visible - can the control be seen?

  property OnChange: TNotifyEvent; [rw]

  

OnChange - event handler for a change in the current page

  property OnChanging;

  

OnChanging - event handler for changing a tab

  property OnCloseTabClicked;

  property OnContextPopup;

  

Event handler to supply information when a context-sensitive pop-up menu is required

  property OnDockDrop;

  

Event handler for the drop of a control to be docked.

  property OnDockOver;

  

Event handler for moves of a control over this docksite.

  property OnDragDrop;

  

Event handler for the drop of a control onto this control.

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnEndDock;

  

Event handler for the end of a docking operation

  property OnEndDrag;

  

Event handler for the end of a dragging process

  property OnEnter;

  

OnEnter - event handler for when the mouse enters the control, and the control receives focus

  property OnExit;

  

OnExit - event handler for when the mouse leaves the control and it loses focus

  property OnGetImageIndex;

  

OnGetImageIndex - event handler for getting an image index

  property OnGetSiteInfo;

  

OnGetSiteInfo - event handler for finding out information about the (docking) site

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseEnter;

  property OnMouseLeave;

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnPageChanged;

  

OnPageChanged - event handler for a change in the page

  property OnResize;

  

Event Handler for resize of control

  property OnStartDock;

  

Event handler for the start of a docking operation

  property OnStartDrag;

  

Event handler for start of dragging operation

  property OnUnDock;

  

Event handler for control becoming disconnected (undocked) from parent.

  property Options;

end;

Inheritance

TPageControl

  

TPageControl - provides a series of tabs along the edge of a multi-page component, to allow selection of one of the pages (TTabSheet) of the component.

|

TCustomNotebook

  

TCustomNotebook: The base type for TNotebook and TPageControl

|

TWinControl

|

TControl

|

TLCLComponent

  

TLCLComponent - base class for LCL components

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

TObject

Description

TPageControl - provides a series of tabs along the edge of a multi-page component, to allow selection of one of the pages (TTabSheet) of the component.

To use TPageControl, select its icon from the Common Controls tab of the IDE Component Palette, and place it at the desired location on the Form.

Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring, docking and other properties, then select the object and right click with the mouse to bring up a pop-up menu whose frst item is 'AddPage'. After you have added as many pages as you need, the individual pages can be edited by selecting ActivePage in the Object Inspector, choosing the page required, and editing its properties.

While a given page is selected, it is also possible to drop other controls (such as buttons, memo boxes etc) on to the page from the Component Palette.

See also

Multi-PageControls

  

Multi-PageControls - controls that offer a selection of alternative pages for display

The latest version of this document can be found at lazarus-ccr.sourceforge.net.