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

# TTabControl

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

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

## Declaration

Source position: comctrls.pp line 559

`type TTabControl = class(TCustomTabControl)`
`public`
`property DisplayRect;` |  | DisplayRect - the rectangular area to be used for displaying information determined by the identity of the selected Tab
`published`
`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 HotTrack;` |  | HotTrack - the property whereby the item under the mouse pointer becomes emphasised
`property Images;` |  | Images - the list of Images available for display in the DisplayRect
`property MultiLine;` |  | MultiLine - whether the Tab's caption is allowed to have multiple lines
`property MultiSelect;` |  | MultiSelect - whether multiple Tabs are allowed to be selected at the same time (eg by pressing Shift or Ctrl while selecting)
`property OnChange;` |  | OnChange - event handler for a change in the Tabs
`property OnChangeBounds;` |  | Event handler for a change in bounds of the control
`property OnChanging;` |  | OnChanging - event handler while Tab is changing
`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 OnDrawTab;` |  | OnDrawTab - event handler for drawing a Tab
`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 finding the index value of the required image
`property OnGetSiteInfo;` |  | OnGetSiteInfo - event handler for getting information about the current 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 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 OwnerDraw;` |  | OwnerDraw - is the calling routine (Owner) allowed to specify the drawing method?
`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 RaggedRight;` |  | RaggedRight - un-justified or un-aligned text
`property ScrollOpposite;` |  | ScrollOpposite - is scrolling to happen in the opposite direction to usual?
`property ShowHint;` |  | Flag to determine: Is hint to be displayed for this control?
`property Style;` |  | Style - Tabs, buttons or flat buttons?
`property TabHeight;` |  | TabHeight - height of the tabs
`property TabIndex;` |  | TabIndex - index value of current Tab. If none selected, default value of -1 is returned
`property TabOrder;` |  | The place this control occupies in the list of tabs
`property TabPosition;` |  | TabPosition - top, bottom, left or right
`property Tabs;` |  | Tabs - the actual Tabs expressed as strings
`property TabStop;` |  | Is the control in the sequence of controls accessed by successive presses of the Tab key?
`property TabWidth;` |  | TabWidth - width of the tabs
`property Visible;` |  | Visible - can the control be seen?
`end;`

## Inheritance

`TTabControl` |  | TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect
`TCustomTabControl` |  | TCustomTabControl - base class for TTabControl, a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect
`TCustomControl` |  | TCustomControl - a base class for many window controls
`TWinControl`
`TControl`
`TLCLComponent` |  | TLCLComponent - base class for LCL components
`TComponent,IUnknown,IInterfaceComponentReference`
`TPersistent`
`TObject`

## Description

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

Use TTabControl by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it at the desired location on the Form. Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring and other properties. Tabs can be aded or removed from the component by selecting it, then right-clicking with the mouse to get a pop-up menu whose first item is 'Add Tab'. Once created, the Tabs can be edited by selecting the Tabs entry in the Object Inspector, and selecting the ellipsis (...) which will cause a pop-up String editor to appear. The tabs can be given new captions, moved up and down the list, or removed altogether, as required.

Each Tab has an Index (starting from 0) and this index can be used to specify an entry from Images for display in the DisplayRect.

## 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.