TTabControl class

In unit ComCtrls

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

Declaration

pascal

TTabControl = class(TCustomTabControl)

Inheritance

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

Properties

`DisplayRect`	public	Display area for the tab 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.
`MultiSelect`	published	Indicates whether multiple tabs can be simultaneously selected on the tabbed control.
`OwnerDraw`	published	Reads and write the value for the OwnerDraw property in Tabs.
`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.
`Style`	published	Indicates the appearance or display style used for the tabs on the control.
`TabPosition`	published	Indicates the edge where the tabs for the control are aligned.
`TabHeight`	published	Height in pixels for the tabs on the control.
`TabIndex`	published	Contains the ordinal position for the active Tab in the control.
`Tabs`	published	Contains the list of pages accessible in the tabbed control.
`TabStop`	published	Enables or disables navigation using the Tab key.
`TabWidth`	published	Width in pixels for the tabs on the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`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.
`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.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Methods

`WSRegisterClass`	protected	Registers the class type with the widgetset.
`SetOptions`	protected	Sets the value for the Options property.
`AddRemovePageHandle`	protected	Not implemented in TTabControl. Page handles are not used.
`CanChange`	protected	Indicates whether the tab control can update its Tabs property.
`CanShowTab`	protected	Indicates if the control can show the tab at the specified position.
`Change`	protected	Changes the active tab for the control.
`CreateWnd`	protected	Creates the Handle for the widgetset object and displays the selected tab and page.
`DestroyHandle`	protected	Destroys the handle for the control and all child controls.
`DestroyWnd`	protected	Frees the handle for a Canvas allocated for the control.
`Notification`	protected	Handles the notification when a component is added to or removed from the class instance.
`SetDragMode`	protected	Sets the value for the DragMode property.
`SetTabIndex`	protected	Sets the value for the TabIndex property.
`UpdateTabImages`	protected	Calls the corresponding method in Tabs.
`ImageListChange`	protected	Calls the corresponding method in Tabs.
`DoSetBounds`	protected	Updates the bounds for the control to the specified values.
`GetControlClassDefaultSize`	protected	Gets the default size for new instances of the class.
`PaintWindow`	protected	Updates the canvas handle and paints the control.
`Paint`	protected	Paints the control to its Canvas using theme services.
`AdjustDisplayRectWithBorder`	protected	Adjust the specified display rectangle to use the size in Tabs.
`AdjustClientRect`	protected	Calls the AdjustDisplayRect method.
`CreateTabNoteBookStrings`	protected	Creates the TTabControlNoteBookStrings instance used in Tabs.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`IndexOfTabAt`	public	Gets the position for the tab at the specified mouse coordinates.
`GetHitTestInfoAt`	public	Gets a set of hit test results for the specified mouse coordinates.
`GetImageIndex`	public	Signals the OnGetImageIndex event handler to get an image for the specified tab index.
`IndexOfTabWithCaption`	public	Gets the ordinal position for the tab with the specified Caption.
`TabRect`	public	Gets the rectangle where the tab at the specified position is drawn.
`RowCount`	public	Gets the number of rows needed to render the Tabs on the control.
`ScrollTabs`	public	Scrolls the tabs on the control horizontally by the value specified in Delta.
`BeginUpdate`	public	Starts an update process for the control.
`EndUpdate`	public	Finishes an update process for the control.
`IsUpdating`	public	Indicates if there are unfinished updates for one of the Tabs on the control.

Events

`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.
`OnGetImageIndex`	published	Event handler signalled to get the image index for a tab on the tabbed control.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`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.
`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.