TabSheet

Qualified name: delphivcl.TabSheet

class TabSheet

Bases: WinControl

TTabSheet is an individual page in a TPageControl object. Use TTabSheet to represent a single page in a tabbed page control. Tab sheets are typically referred to as pages. TPageControl maintains an indexed array of its tab sheets in its Pages property. Users can click on a tab to activate the tab sheet. You can use the Caption property of the TTabSheet control to define an accelerator key to a page of the TPageControl.

Methods

CanFocus	Indicates whether a control can receive focus.
Create	Creates and initializes an instance of TTabSheet.
Destroy	Destroys an instance of TTabSheet.
SetFocus	Gives the input focus to the control.

Attributes

Action	Specifies the action associated with the control.
Align	Determines how the control aligns within its container (parent control).
AlignDisabled	Indicates child control realignment disabled.
AlignWithMargins	Specifies whether a control should be constrained by margins.
Anchors	Specifies how the control is anchored to its parent.
BiDiMode	Specifies the bidirectional mode for the control.
BorderWidth	Specifies the width of the control's border.
BoundsRect	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
Brush	Determines the color and pattern used for painting the background of the control.
Caption	Specifies a text string that identifies the control to the user.
ClassName	Returns the TObject.ClassName
ClientHeight	Specifies the height of the control's client area in pixels.
ClientOrigin	Specifies the screen coordinates (in pixels) of the upper-left corner of a control's client area.
ClientRect	Specifies the size of a control's client area in pixels.
ClientWidth	Specifies the horizontal size of the control's client area in pixels.
ComObject	Specifies the interface reference implemented by the component.
ComponentCount	Indicates the number of components owned by the component.
ComponentIndex	Indicates the position of the component in its owner's Components property array.
ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStyle	Governs the behavior of the component.
Components	<Delphi indexed property Components of type TComponent at 21141642500>
Constraints	Specifies the size constraints for the control.
ControlCount	Returns the count of contained controls
ControlState	Specifies the current state of a control at run time.
ControlStyle	Determines style characteristics of the control.
Controls	Returns an iterator over contained controls
CurrentPPI	Embarcadero Technologies does not currently have any additional information.
Cursor	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
CustomHint	CustomHint is a custom hint for the control.
DesignInfo	Contains information used by the Form designer.
DockClientCount	Specifies the number of controls that are docked on the windowed control.
DockClients	<Delphi indexed property DockClients of type TWinControl at 211416EE520>
DockManager	Specifies the control's docking manager interface.
DockOrientation	DockOrientation specifies how the control is docked relative to other controls docked in the same parent.
DockSite	Specifies whether the control can be the target of drag-and-dock operations.
DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
DragMode	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
ExplicitHeight	Specifies the explicit vertical size of the control in pixels.
ExplicitLeft	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
ExplicitTop	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
ExplicitWidth	Specifies the explicit horizontal size of the control in pixels.
Floating	Specifies whether the control is floating.
FloatingDockSiteClass	Specifies the class of the temporary control that hosts the control when it is floating.
Focused	Determines whether the control has input focus.
Font	Specifies the attributes of text written on or in the control.
Handle	Provides access to the underlying Windows screen object for the control.
HandleAllocated	Reports whether a screen object handle exists for the control.
Height	Specifies the vertical size of the control in pixels.
HelpContext	The HelpContext property contains the numeric context ID that identifies the Help topic for the control.
HelpKeyword	The HelpKeyword property contains the keyword string that identifies the Help topic for the control.
HelpType	Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
Highlighted	Indicates whether the tab sheet appears highlighted.
Hint	Hint contains the text string that appears when the user moves the mouse over the control.
HostDockSite	Specifies the control in which the control is docked.
ImageIndex	Specifies an image for the tab.
ImageName	Displays the name of linked items from the Image Collection.
IsDrawingLocked	IsDrawingLocked property returns True when redrawing for this control is locked.
LRDockWidth	Specifies the width of the control when it is docked horizontally.
Left	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
Margins	Specifies the margins of the control.
MouseInClient	Indicates whether the mouse pointer is currently in the client area of the control.
Name	Specifies the name of the component as referenced in code.
Observers	Indicates the TObservers object added to the TComponent.
OnContextPopup	<Delphi property OnContextPopup of type TTabSheet at 211412A9900>
OnDragDrop	<Delphi property OnDragDrop of type TTabSheet at 211412A99D0>
OnDragOver	<Delphi property OnDragOver of type TTabSheet at 211412A9AA0>
OnEndDrag	<Delphi property OnEndDrag of type TTabSheet at 211412A9B70>
OnEnter	<Delphi property OnEnter of type TTabSheet at 211412A9C40>
OnExit	<Delphi property OnExit of type TTabSheet at 211412A9D10>
OnGesture	<Delphi property OnGesture of type TTabSheet at 211412A9DE0>
OnHide	<Delphi property OnHide of type TTabSheet at 211412A9EB0>
OnMouseActivate	<Delphi property OnMouseActivate of type TTabSheet at 211412A9F80>
OnMouseDown	<Delphi property OnMouseDown of type TTabSheet at 211412AA050>
OnMouseEnter	<Delphi property OnMouseEnter of type TTabSheet at 211412AA120>
OnMouseLeave	<Delphi property OnMouseLeave of type TTabSheet at 211412AA1F0>
OnMouseMove	<Delphi property OnMouseMove of type TTabSheet at 211412AA2C0>
OnMouseUp	<Delphi property OnMouseUp of type TTabSheet at 211412AA390>
OnResize	<Delphi property OnResize of type TTabSheet at 211412AA460>
OnShow	<Delphi property OnShow of type TTabSheet at 211412AA530>
OnStartDrag	<Delphi property OnStartDrag of type TTabSheet at 211412AA600>
Owner	Indicates the component that is responsible for streaming and freeing this component.
Padding	Specifies the padding of a control.
PageControl	Indicates the page control object that contains the tab sheet.
PageIndex	Indicates the index of the tab sheet in the list of tab sheets maintained by the page control.
Parent	Specifies the parent of the control.
ParentCustomHint	Specifies where a control looks for its custom hint.
ParentDoubleBuffered	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
ParentFont	Specifies where a control looks for its font information.
ParentShowHint	Specifies where a control looks to find out if its Help Hint should be shown.
ParentWindow	Reference to parent's underlying control.
PixelsPerInch	Embarcadero Technologies does not currently have any additional information.
PopupMenu	Specifies the pop-up menu associated with the control.
RedrawDisabled	RedrawDisabled property returns True when redrawing for this control is locked.
ScaleFactor	Embarcadero Technologies does not currently have any additional information.
ShowHint	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
Showing	Indicates whether the control is showing on the screen.
StyleElements	Specifies the style elements that are used by the control.
StyleName	Embarcadero Technologies does not currently have any additional information.
TBDockHeight	Specifies the height of the control when it is docked vertically.
TabIndex	Indicates the position of the tab sheet in the set of visible tabs in a TPageControl object.
TabOrder	Indicates the position of the control in its parent's tab order.
TabStop	Determines whether the user can tab to a control.
TabVisible	Specifies whether the tab of the TTabSheet object appears in its TPageControl.
Tag	Stores a NativeInt integral value as a part of a component.
Top	Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
Touch	Specifies the touch manager component associated with the control.
UndockHeight	Specifies the height of the control when it is floating.
UndockWidth	Specifies the width of the control when it is floating.
UseDockManager	Specifies whether the docking manager is used in drag-and-dock operations.
VCLComObject	Represents information used internally by components that support COM.
Visible	Specifies whether the component appears onscreen.
VisibleDockClientCount	Specifies the number of visible controls that are docked on the windowed control.
Width	Specifies the horizontal size of the control or form in pixels.
WindowProc	<Delphi property WindowProc of type TControl at 211418EC1C0>

BorderWidth

Specifies the width of the control’s border. Use BorderWidth to get or set the width of the control’s border. Graphics or text drawn by the control is clipped to the area within the border.

CanFocus()

Indicates whether a control can receive focus.

Caption

Specifies a text string that identifies the control to the user. Use Caption to specify the text string that labels the control. To underline a character in a Caption that labels a component, include an ampersand (&) before the character. This type of character is called an accelerator character. The user can then select the component by pressing ALT while typing the underlined character. To display an ampersand character in the caption, use two ampersands (&&).

Notes: Controls that display text use either the Caption property or the Text property to specify the text value. The property that is used depends on the type of control. In general, Caption is used for text that appears as a window title or label, while Text is used for text that appears as the content of a control. For some controls, such as TButton, it is not possible to change the color of the Caption. If you want to change the color of a button caption, you should use an alternate button type such as TSpeedButton or TBitBtn instead of TButton. With either TSpeedButton or TBitBtn, you can change the color of the Caption property by using the Font property. For TLinkLabel, an HTML tag is declared inside the Caption property either at run time or at design time.

Constraints

Specifies the size constraints for the control. Use Constraints to specify the minimum and maximum width and height of the control. When Constraints contains maximum or minimum values, the control cannot be resized to violate those constraints.

Note: Constraints apply to the height of the form. However, the height of the form depends on how large Windows makes the title bar. For example, Windows XP uses much larger title bars than other windowing systems. To work around this, note the ClientHeight when you design your form and set the constraints in the FormCreate event. In the following example, ClientHeight is represented by x: Constraints.MinHeight?:= x + Height - ClientHeight. Warning: Do not set up constraints that conflict with the value of the Align or Anchors property. When these properties conflict, the response of the control to resize attempts is not well-defined.

ControlCount

Returns the count of contained controls

Controls

Returns an iterator over contained controls

Create(AOwner: Component)

Creates and initializes an instance of TTabSheet. Call Create to instantiate a tab sheet at runtime. Tab sheets added to a page control at design time are created automatically. Create calls the inherited Create method, then sets the initial values for the tab sheet component. When creating tab sheets at runtime, use the PageControl property to insert them into a page control object.

Destroy()

Destroys an instance of TTabSheet. Do not call Destroy directly at runtime. Instead, call Free. Free verifies that the tab sheet is not nil and only then calls Destroy. Destroy removes the tab sheet from the page control and then calls the inherited Destroy method.

DoubleBuffered

Determines whether the control’s image is rendered directly to the window or painted to an in-memory bitmap first. When DoubleBuffered is false, the windowed control paints itself directly to the window. When DoubleBuffered is true, the windowed control paints itself to an in-memory bitmap that is then used to paint the window. Double buffering reduces the amount of flicker when the control repaints, but is more memory intensive. When a windowed control is a dock site and has an associated dock manager, it must be double-buffered.

Note: Some controls, such as TRichEdit, can’t paint themselves into a bitmap. For such controls, DoubleBuffered must be set to false.

DragMode

Specifies how the control initiates drag-and-drop or drag-and-dock operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop or drag-and-dock capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic. For more information about dmManual and dmAutomatic, see TDragMode.

Enabled

Controls whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True.

Note: This property applies to all TControl descendants.

Focused

Determines whether the control has input focus.

Font

Specifies the attributes of text written on or in the control. To change to a new font, specify a new TFont object. To modify a font, change the value of the Charset, Color, Height, Name , Pitch, Size, or Style of the TFont object.

Note: Changing the font color of the Caption is not supported for some controls (such as TButton). In most cases, there is an alternate control you can use whose Font property will change the color of the caption or text (such as TBitBtn or TSpeedButton).

Handle

Provides access to the underlying Windows screen object for the control.

HandleAllocated

Reports whether a screen object handle exists for the control.

Height

Specifies the vertical size of the control in pixels. Use the Height property to read or change the height of the control.

Highlighted

Indicates whether the tab sheet appears highlighted. Use Highlighted to make a tab sheet stand out visually. When Highlighted is true, the tab sheet is drawn using a highlight color so that it stands out visually from other tab sheets.

Note: Highlighted is not linked to the active page of the host page control. A page control can have only one active page, but can have multiple highlighted pages.

ImageIndex

Specifies an image for the tab. Use ImageIndex to get or set the index of an image to be drawn in the tab. This index identifies an image from the Images property of the page control that contains the tab sheet. Specify -1 to prevent an image from being drawn.

ImageName

Displays the name of linked items from the Image Collection.

Left

Specifies the horizontal coordinate of the left edge of a component relative to its parent. Use the Left property to determine where the left side of the control begins or to reposition the left side of the control. If the control is contained in another control, the Left and Top properties are relative to the parent control. If the control is contained directly by the form, the property values are relative to the form. For forms, the value of the Left property is relative to the screen in pixels.

OnContextPopup

<Delphi property OnContextPopup of type TTabSheet at 211412A9900>

OnDragDrop

<Delphi property OnDragDrop of type TTabSheet at 211412A99D0>

OnDragOver

<Delphi property OnDragOver of type TTabSheet at 211412A9AA0>

OnEndDrag

<Delphi property OnEndDrag of type TTabSheet at 211412A9B70>

OnEnter

<Delphi property OnEnter of type TTabSheet at 211412A9C40>

OnExit

<Delphi property OnExit of type TTabSheet at 211412A9D10>

OnGesture

<Delphi property OnGesture of type TTabSheet at 211412A9DE0>

OnHide

<Delphi property OnHide of type TTabSheet at 211412A9EB0>

OnMouseActivate

<Delphi property OnMouseActivate of type TTabSheet at 211412A9F80>

OnMouseDown

<Delphi property OnMouseDown of type TTabSheet at 211412AA050>

OnMouseEnter

<Delphi property OnMouseEnter of type TTabSheet at 211412AA120>

OnMouseLeave

<Delphi property OnMouseLeave of type TTabSheet at 211412AA1F0>

OnMouseMove

<Delphi property OnMouseMove of type TTabSheet at 211412AA2C0>

OnMouseUp

<Delphi property OnMouseUp of type TTabSheet at 211412AA390>

OnResize

<Delphi property OnResize of type TTabSheet at 211412AA460>

OnShow

<Delphi property OnShow of type TTabSheet at 211412AA530>

OnStartDrag

<Delphi property OnStartDrag of type TTabSheet at 211412AA600>

PageControl

Indicates the page control object that contains the tab sheet. Read PageControl to gain access to the page control object that uses the tab sheet. The properties and methods of the PageControl object can be used to locate the selected page, iterate through the other pages in the page control, or change the display properties of the tabs. Set PageControl to remove the tab sheet from its current page control (if any) and insert it into a new page control.

Code Examples TTabSheetPageControl (Delphi) TabSheetPageControl (Delphi) TTabSheetPageControl (C++) TabSheetPageControl (C++)

PageIndex

Indicates the index of the tab sheet in the list of tab sheets maintained by the page control. Use PageIndex to determine where the tab sheet sits in its page control. Each tab sheet in a page control is automatically assigned a PageIndex when it is inserted in the page control. The first tab sheet receives a value of 0, the second has a value of 1, and so on. PageIndex values are reassigned if tab sheets are deleted or moved. To access a particular tab sheet given its index value, use the indexed Pages property of the TPageControl object.

ParentDoubleBuffered

ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent’s DoubleBuffered property. ParentDoubleBuffered is a boolean indicating that the DoubleBuffered property of this component is overridden by the value of the parent’s DoubleBuffered property.

ParentFont

Specifies where a control looks for its font information. To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property. Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control’s Font property changes, ParentFont becomes false automatically. When ParentFont is true for a form, the form uses the default font. Currently, the default font is Tahoma 8 pt.

ParentShowHint

Specifies where a control looks to find out if its Help Hint should be shown. Use ParentShowHint to ensure that all the controls on a form either uniformly show their Help Hints or uniformly do not show them. If ParentShowHint is True, the control uses the ShowHint property value of its parent. If ParentShowHint is False, the control uses the value of its own ShowHint property. To provide Help Hints only for selected controls on a form, set the ShowHint property for those controls that should have Help Hints to True, and ParentShowHint becomes False automatically.

Note: Enable or disable all Help Hints for the entire application using the ShowHint property of the application object.

ParentWindow

Reference to parent’s underlying control.

PopupMenu

Specifies the pop-up menu associated with the control. Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button. If the TPopupMenu’s AutoPopup property is True, the pop-up menu appears automatically. If the menu’s AutoPopup property is False, display the menu with a call to its Popup method from the control’s OnContextPopup event handler.

SetFocus()

Gives the input focus to the control.

ShowHint

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. ShowHint determines whether the Help Hint appears for the control. The Help Hint is the value of the TControl.Hint property. The Help Hint appears in a box just beneath the control when the mouse pointer moves over the control. To enable Help Hints for a particular control, two conditions must be satisfied:

The application’s ShowHint property must be True. Either the control’s own ShowHint property must be True, or the control’s ParentShowHint property must be True and its parent’s ShowHint property must be True. For example, imagine a check box within a group box. If the ShowHint property of the group box is True and the ParentShowHint property of the check box is True, but the ShowHint property of the check box is False, the check box still displays its Help Hint. Changing the ShowHint value automatically sets the ParentShowHint property to False.

Showing

Indicates whether the control is showing on the screen.

TabIndex

Indicates the position of the tab sheet in the set of visible tabs in a TPageControl object. Read TabIndex to determine where the user sees the tab sheet. A value of 0 indicates the first visible tab sheet, a value of 1 indicates the second visible tab sheet, and so on. TabIndex is always less than or equal to PageIndex. For example, a tab sheet that has a PageIndex of 3 will have a TabIndex of 2 if one of the previous tab sheets in the page control is not visible. If a tab sheet’s TabVisible property is false, the TabIndex property is -1.

TabVisible

Specifies whether the tab of the TTabSheet object appears in its TPageControl. Use TabVisible to temporarily remove a tab sheet from a page control. When TabVisible is false, the tab does not appear in the page control and its TabIndex property is -1. Setting TabVisible to true allows the user to see the tab of the tab sheet again.

Top

Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels. Use Top to locate the top of the control or reposition the control to a different Y coordinate. The Top property, like the Left property, is the position of the control relative to its container. Thus, if a control is contained in a TPanel, the Left and Top properties are relative to the panel. If the control is contained directly by the form, it is relative to the form. For forms, the value of the Top property is relative to the screen in pixels.

Touch

Specifies the touch manager component associated with the control. Use the Touch property to access gesturing options associated with a control. Touch specifies a class of type TTouchManager. Touch is used to:

Associate a TGestureManager. (TGestureManager manages all the gestures that can be used by the control.) Select the standard, interactive, or custom gestures to associate with the control. (You can also connect each gesture to an action; see Assigning Actions to Gestures.) Specify a set of options for interactive or tablet gestures.

Visible

Specifies whether the component appears onscreen. Use the Visible property to control the visibility of the control at run time. If Visible is True, the control appears. If Visible is False, the control is not visible. Calling the Show method sets the control’s Visible property to True. Calling the Hide method sets it to False. For TCustomForm descendants, the Show and ShowModal methods set Visible to True and bring the form to the front of all open windows. For TTabSheet descendants, Visible does not control the visibility of the control at run time. For more information, see the description of the TabVisible property.

Width

Specifies the horizontal size of the control or form in pixels. Use the Width property to read or change the width of the control.

Note: For tab sheet controls, changing this property at run time has no effect.