TPageControl class

In unit ComCtrls

Implements a multi-page component with a series of tabs.

Declaration

pascal

TPageControl = class(TCustomTabControl)

Inheritance

Descends from it: TNoteBookStringsTabControl

Description

TPageControl provides a series of tabs along an edge of a multi-page component to allow selection of one of the pages ( TTabSheet) defined for 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 first 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) onto the page from the Component Palette.

Inherits most of its properties from TCustomTabControl

Properties

`ActivePageIndex`	public	Ordinal position for the active page (tab sheet) on the page control.
`Pages`	public	Provides indexed access to the pages (tab sheets) on the page control.
`ActivePage`	published	The currently selected and active page ( TTabSheet) on the page control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DockSite`	published	Allows controls to be drag-and-dock-ed into this control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`HotTrack`	published	Enables or disables drawing a "hot-lighted" tab when the mouse pointer is hovered over the control.
`Images`	published	Contains the images displayed on the tabs for the control.
`ImagesWidth`	published	Width for the Images used in the control.
`MultiLine`	published	Indicates whether the caption on a tab can have multiple lines of text.
`Options`	published	The set of Options enabled for the tabbed control.
`ParentBiDiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`RaggedRight`	published	Enables or disables justified text in the captions for tabs on the control.
`ScrollOpposite`	published	Indicates whether unused multi-line tabs are scrolled to the side opposite of the tab position.
`ShowHint`	published	Enables Hint display for the control.
`ShowTabs`	published	Enables display of tabs on the control when set to True (default).
`Style`	published	Indicates the appearance or display style used for the tabs on the control.
`TabHeight`	published	Height in pixels for the tabs on the control.
`TabIndex`	published	Contains the ordinal position for the active Tab in the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabPosition`	published	Indicates the edge where the tabs for the control are aligned.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`TabWidth`	published	Width in pixels for the tabs on the control.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`GetPageClass`	protected	Gets the class type used to create a new tab sheet (or page) for the page control.
`DoAddDockClient`	protected	DoAddDockClient creates a new tab sheet in the PageControl, places the client on it and aligns it.
`DockOver`	protected	Called to check whether this control allows docking and where.
`DoRemoveDockClient`	protected	DoRemoveDockClient - frees the page which is being undocked.
`DoUndockClientMsg`	protected	Notifies the DockManager of the undock of a client control.
`ChildClassAllowed`	protected	Determines whether the specified class can be a child control on the TPageControl instance.
`UpdateDockCaption`	protected	Updates page captions to reflect the captions for docked clients controls.
`Clear`	public	Clears the list of tab names in the control, and frees the associated tab sheets or pages.
`FindNextPage`	public	Gets the next tab sheet in the specified direction.
`SelectNextPage`	public	Locates and activates the next page in the specified direction.
`IndexOfTabAt`	public	Returns the ordinal position for the visible tab located at the specified client coordinates.
`IndexOfPageAt`	public	Gets the ordinal position for the page object located at the specified client coordinates.
`AddTabSheet`	public	Creates and configures a new tab sheet for the page control.

Events

`OnGetDockCaption`	published	This handler can provide a special DockCaption, different than the Caption default.
`OnChange`	published	Event handler signalled when the active page (or tab) for the control is changed.
`OnChanging`	published	Event handler signalled prior to changing the active tab/page on the tabbed control.
`OnCloseTabClicked`	published	Event handler signalled when a tab is closed.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDockDrop`	published	Event handler signalled for the drop of a control to be docked.
`OnDockOver`	published	Event handler signalled when a control is moved over a docksite; determines whether the drop event is accepted or rejected.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEndDock`	published	Event handler signalled for the end of a drag-dock operation.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnGetImageIndex`	published	Event handler signalled to get the image index for a tab on the tabbed control.
`OnGetSiteInfo`	published	Provides information about the DockSite for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnStartDock`	published	Event handler for the start of a docking operation.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUnDock`	published	Event handler signalled before a control is undocked from its DockSite.