ToggleSwitch#

Qualified name: delphivcl.ToggleSwitch

class ToggleSwitch#

Bases: CustomToggleSwitch

A clickable control that allows a user to toggle between an On state and an Off state.

Methods

BringToFront

Puts the control in front of all other controls in its parent control.

ClientToScreen

Translates a given point from client area coordinates to global screen coordinates.

Hide

Hides the wrapped Control

Invalidate

Completely repaint control.

Repaint

Forces the control to repaint its image on the screen.

ScreenToClient

Converts the screen coordinates of a specified point on the screen to client coordinates.

SendToBack

Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds

Sets the Left, Top, Width, and Height properties all at once.

Show

Shows the wrapped Control

Update

Processes any pending paint messages immediately.

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.

Alignment

Specifies whether the toggle switch caption is displayed on the right or the left side.

Anchors

Specifies how the control is anchored to its parent.

AutoSize

Indicates whether the control adjusts its bounds based on the SwitchHeight, SwitchWidth, and StateCaptions properties.

BiDiMode

Specifies the bidirectional mode for the control.

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.

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.

Color

Specifies the background color of the control.

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 number of child controls.

ControlState

Specifies the current state of a control at run time.

ControlStyle

Determines style characteristics of the control.

Controls

<Delphi indexed property Controls of type TWinControl at 211416EE760>

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.

DisabledColor

The color of the toggle switch when it is disabled.

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.

DragCursor

Specifies the image used to represent the mouse pointer when the control is being dragged.

DragKind

Specifies whether the control is being dragged normally or for docking.

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.

Font

Specifies the attributes of text written on or in the control.

FrameColor

The color of the toggle switch frame.

Handle

Provides access to the underlying Windows screen object 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.

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.

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.

OnClick

<Delphi property OnClick of type TToggleSwitch at 21141C5C700>

OnContextPopup

<Delphi property OnContextPopup of type TToggleSwitch at 21141C5C7D0>

OnDragDrop

<Delphi property OnDragDrop of type TToggleSwitch at 21141C5C8A0>

OnDragOver

<Delphi property OnDragOver of type TToggleSwitch at 21141C5C970>

OnEndDock

<Delphi property OnEndDock of type TToggleSwitch at 21141C5CA40>

OnEndDrag

<Delphi property OnEndDrag of type TToggleSwitch at 21141C5CB10>

OnEnter

<Delphi property OnEnter of type TToggleSwitch at 21141C5CBE0>

OnExit

<Delphi property OnExit of type TToggleSwitch at 21141C5CCB0>

OnGesture

<Delphi property OnGesture of type TControl at 211418EC500>

OnKeyDown

<Delphi property OnKeyDown of type TToggleSwitch at 21141C5CD80>

OnKeyPress

<Delphi property OnKeyPress of type TToggleSwitch at 21141C5CE50>

OnKeyUp

<Delphi property OnKeyUp of type TToggleSwitch at 21141C5CF20>

OnMouseActivate

<Delphi property OnMouseActivate of type TToggleSwitch at 21141C5CFF0>

OnMouseDown

<Delphi property OnMouseDown of type TToggleSwitch at 21141C5D0C0>

OnMouseEnter

<Delphi property OnMouseEnter of type TToggleSwitch at 21141C5D190>

OnMouseLeave

<Delphi property OnMouseLeave of type TToggleSwitch at 21141C5D260>

OnMouseMove

<Delphi property OnMouseMove of type TToggleSwitch at 21141C5D330>

OnMouseUp

<Delphi property OnMouseUp of type TToggleSwitch at 21141C5D400>

OnStartDock

<Delphi property OnStartDock of type TToggleSwitch at 21141C5D4D0>

OnStartDrag

<Delphi property OnStartDrag of type TToggleSwitch at 21141C5D5A0>

Owner

Indicates the component that is responsible for streaming and freeing this component.

Padding

Specifies the padding of a control.

Parent

Returns/Sets the Control Parent

ParentBiDiMode

Specifies whether the control uses its parent's BiDiMode.

ParentColor

Specifies where a control looks for its color information.

ParentCtl3D

Determines where a component looks to determine whether it should have a three-dimensional look.

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.

ReadOnly

Indicates whether the toggle switch is in read-only mode.

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.

ShowStateCaption

Indicates whether to display the captions of the switch.

Showing

Indicates whether the control is showing on the screen.

State

The current state of the toggle switch.

StateCaptions

The captions of the toggle switch.

StyleElements

Specifies the style elements that are used by the control.

StyleName

Embarcadero Technologies does not currently have any additional information.

SwitchHeight

The height of the toggle switch excluding the captions.

SwitchWidth

The width of the toggle switch excluding the captions.

TBDockHeight

Specifies the height of the control when it is docked vertically.

TabOrder

Indicates the position of the control in its parent's tab order.

TabStop

Determines whether the user can tab to a control.

Tag

Stores a NativeInt integral value as a part of a component.

ThumbColor

The color of the toggle switch thumb.

ThumbWidth

The width of the thumb inside the toggle switch frame.

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>

Action#

Specifies the action associated with the control. Action is the action object that is associated with the control. Actions allow an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). To create actions at design time, place an action list component on a form or data module. Double-click the action list to bring up the action list editor. Add actions in the editor using its context menu. Once the actions have been added using the Action List editor, they appear in the drop-down list for the Action property in the Object Inspector.

Align#

Determines how the control aligns within its container (parent control). Use Align to align a control to the top, bottom, left, or right of a form or panel and have it remain there even if the size of the form, panel, or component that contains the control changes. When the parent is resized, an aligned control also resizes so that it continues to span the top, bottom, left, or right edge of the parent. For example, to use a panel component with various controls on it as a tool palette, change the panel’s Align value to alLeft. The value of alLeft for the Align property of the panel guarantees that the tool palette remains on the left side of the form and always equals the client height of the form. The default value of Align is alNone, which means a control remains where it is positioned on a form or panel.

Tip: If Align is set to alClient, the control fills the entire client area so that it is impossible to select the parent form by clicking it. In this case, select the parent by selecting the control on the form and pressing ESC, or by using the Object Inspector. Any number of child components within a single parent can have the same Align value, in which case they stack up along the edge of the parent. The child controls stack up in z-order. To adjust the order in which the controls stack up, drag the controls into their desired positions.

Note: To cause a control to maintain a specified relationship with an edge of its parent, but not necessarily lie along one edge of the parent, use the Anchors property instead.

Alignment#

Specifies whether the toggle switch caption is displayed on the right or the left side. Default is taRightJustify.

Anchors#

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to an edge of its parent, even if the parent is resized. When its parent is resized, the control holds its position relative to the edges to which it is anchored. If a control is anchored to opposite edges of its parent, the control stretches when its parent is resized. For example, if a control has its Anchors property set to [akLeft, akRight], the control stretches when the width of its parent changes. Anchors is enforced only when the parent is resized. Thus, for example, if a control is anchored to opposite edges of a form at design time and the form is created in a maximized state, the control is not stretched because the form is not resized after the control is created.

Note: If a control should maintain contact with three edges of its parent (hugging one side of the parent and stretching the length of that side), use the Align property instead. Unlike Anchors, Align allows controls to adjust to changes in the size of other aligned sibling controls as well as changes to the parent’s size.

AutoSize#

Indicates whether the control adjusts its bounds based on the SwitchHeight, SwitchWidth, and StateCaptions properties. Default is True.

BiDiMode#

Specifies the bidirectional mode for the control. Use BiDiMode to enable the control to adjust its appearance and behavior automatically when the application runs in a locale that reads from right to left instead of left to right. The bidirectional mode controls the reading order for the text, the placement of the vertical scroll bar, and whether the alignment is changed. Alignment does not change for controls that are known to contain number, date, time, or currency values. For example, with data-aware controls, the alignment does not change for the following field types: ftSmallint, ftInteger, ftWord, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftAutoInc.

BringToFront()#

Puts the control in front of all other controls in its parent control.

ClientToScreen()#

Translates a given point from client area coordinates to global screen coordinates.

Color#

Specifies the background color of the control. Use Color to read or change the background color of the control. If a control’s Vcl.Controls.TControl.ParentColor property is True, then changing the Color property of the control’s parent automatically changes the Color property of the control. When the value of the Color property is changed, the control’s ParentColor property is automatically set to False. The Color of a TLabel is always the color of the background unless you set TLabel.Transparent to False.

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.

DisabledColor#

The color of the toggle switch when it is disabled. Default is clBtnShadow.

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.

DragCursor#

Specifies the image used to represent the mouse pointer when the control is being dragged. Use the DragCursor property to change the cursor image presented when the control is being dragged.

Note: To make a custom cursor available for the DragCursor property, see the Cursor property.

DragKind#

Specifies whether the control is being dragged normally or for docking. Use DragKind to get or set whether the control participates in drag-and-drop operations or drag-and-dock operations.

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.

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

FrameColor#

The color of the toggle switch frame. Default is clWindowText.

Height#

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

HelpContext#

The HelpContext property contains the numeric context ID that identifies the Help topic for the control. In case of a .chm help file, you must map symbolic Context IDs of Help topics to numeric topic ID values in the [MAP] section of your project (.hhp) file. To enable Context ID-based context-sensitive Help for a control, set Vcl.Controls.TControl.HelpType to htContext and set HelpContext to a numeric topic ID. A topic ID of 0 (default) means that no Help topic is provided for the control. To use the Help, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. For C++, you need to include the HTMLHelpViewer.hpp header file.

Hide()#

Hides the wrapped Control

Hint#

Hint contains the text string that appears when the user moves the mouse over the control. Use the Hint property to provide a string of Help text either as a Help Hint or as Help text on a particular location, such as a status bar. A Help Hint is a box containing Help text that appears for a control when the user moves the mouse pointer over the control and pauses momentarily. To set up Help Hints

Specify the Hint property of each control for which a Help Hint should appear. Set the ShowHint property of each appropriate control to True, or set the ParentShowHint property of all controls to True and set the ShowHint property of the form to True. At run time, set the value of the application’s ShowHint property to True. To show the Hint on a status bar or another location, use the OnHint event handler of the application. The application’s OnHint event occurs when the mouse pointer moves over the control. Specify a hint to be used for both a Help Hint box and by an OnHint event handler by specifying values separated by a | (pipe) character. For example,

Edit1.Hint := ‘Name|Enter Name in the edit box|1’;

Edit1->Hint = “Name|Enter Name in the edit box|1”;

Here:

The Name part is the short hint and appears at the top of the Help Hint box. Enter full name in the edit box is the long hint and appears below the short hint. It can be extracted using the GetLongHint function for use in an OnHint event handler. 1 is an optional image index in an image list in the Images property of the control and specifies the index of the image to appear in the hint. If Hint contains only one value, the entire string is used as a Help Hint and returned by the GetLongHint and GetShortHint functions. If a control has no Hint value specified, but its parent control does, the control uses the value of the parent control (as long as the control’s ShowHint property is True).

Note: If the application’s ShowHint property is False, the Help Hint does not appear, but the OnHint event handler is still called.

Invalidate()#

Completely repaint control.

OnClick#

<Delphi property OnClick of type TToggleSwitch at 21141C5C700>

OnContextPopup#

<Delphi property OnContextPopup of type TToggleSwitch at 21141C5C7D0>

OnDragDrop#

<Delphi property OnDragDrop of type TToggleSwitch at 21141C5C8A0>

OnDragOver#

<Delphi property OnDragOver of type TToggleSwitch at 21141C5C970>

OnEndDock#

<Delphi property OnEndDock of type TToggleSwitch at 21141C5CA40>

OnEndDrag#

<Delphi property OnEndDrag of type TToggleSwitch at 21141C5CB10>

OnEnter#

<Delphi property OnEnter of type TToggleSwitch at 21141C5CBE0>

OnExit#

<Delphi property OnExit of type TToggleSwitch at 21141C5CCB0>

OnKeyDown#

<Delphi property OnKeyDown of type TToggleSwitch at 21141C5CD80>

OnKeyPress#

<Delphi property OnKeyPress of type TToggleSwitch at 21141C5CE50>

OnKeyUp#

<Delphi property OnKeyUp of type TToggleSwitch at 21141C5CF20>

OnMouseActivate#

<Delphi property OnMouseActivate of type TToggleSwitch at 21141C5CFF0>

OnMouseDown#

<Delphi property OnMouseDown of type TToggleSwitch at 21141C5D0C0>

OnMouseEnter#

<Delphi property OnMouseEnter of type TToggleSwitch at 21141C5D190>

OnMouseLeave#

<Delphi property OnMouseLeave of type TToggleSwitch at 21141C5D260>

OnMouseMove#

<Delphi property OnMouseMove of type TToggleSwitch at 21141C5D330>

OnMouseUp#

<Delphi property OnMouseUp of type TToggleSwitch at 21141C5D400>

OnStartDock#

<Delphi property OnStartDock of type TToggleSwitch at 21141C5D4D0>

OnStartDrag#

<Delphi property OnStartDrag of type TToggleSwitch at 21141C5D5A0>

Parent#

Returns/Sets the Control Parent

ParentBiDiMode#

Specifies whether the control uses its parent’s BiDiMode. Use ParentBiDiMode to get or set whether the control uses its parent’s BiDiMode. When ParentBiDiMode is true, the control’s BiDiMode property is always equal to that of its parent. If ParentBiDiMode is false, the control uses its own BiDiMode property. Set ParentBiDiMode to true for all controls in a form to ensure that the entire user interface adjusts to Middle Eastern locales in a uniform manner. When the value of the control’s BiDiMode property changes, ParentBiDiMode becomes false automatically.

ParentColor#

Specifies where a control looks for its color information. To have a control use the same color as its parent control, set ParentColor to True. If ParentColor is False, the control uses its own Color property. Set ParentColor to True for all controls to ensure that all the controls on a form have a uniform appearance. For example, if ParentColor is True for all controls in a form, changing the background color of the form to gray causes all the controls on the form to also have a gray background. When the value of a control’s Color property changes, ParentColor becomes False automatically.

ParentCtl3D#

Determines where a component looks to determine whether it should have a three-dimensional look. ParentCtl3D is provided for backwards compatibility. It has no effect on 32-bit versions of Windows or NT 4.0 and later. ParentCtl3D determines whether the control uses its parent’s Ctl3D property.

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.

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.

ReadOnly#

Indicates whether the toggle switch is in read-only mode. If True, the user cannot change the state of the toggle switch. You can still change the State programatically. Default is False.

Repaint()#

Forces the control to repaint its image on the screen.

ScreenToClient()#

Converts the screen coordinates of a specified point on the screen to client coordinates.

SendToBack()#

Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds(Left, Top, Width, Height)#

Sets the Left, Top, Width, and Height properties all at once.

Show()#

Shows the wrapped 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.

ShowStateCaption#

Indicates whether to display the captions of the switch. Default is True.

State#

The current state of the toggle switch. Possible values are:

tssOff: Default. The toggle switch is in the off state. tssOn: The toggle switch is in the on state.

StateCaptions#

The captions of the toggle switch.

StyleElements#

Specifies the style elements that are used by the control. Use StyleElements to customize the style of the control. If a custom style is enabled, you can enable or disable style elements in the control. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

StyleName#

Embarcadero Technologies does not currently have any additional information.

SwitchHeight#

The height of the toggle switch excluding the captions.

SwitchWidth#

The width of the toggle switch excluding the captions.

TabOrder#

Indicates the position of the control in its parent’s tab order. TabOrder is the order in which child windows are visited when the user presses the Tab key. The control with the TabOrder value of 0 is the control that has the focus when the form first appears. Initially, the tab order is always the order in which the controls were added to the form. The first control added to the form has a TabOrder value of 0, the second is 1, the third is 2, and so on. Change this by changing the TabOrder property. Each control has a unique tab-order value within its parent. If you change the TabOrder property value of one control to be the same as the value of a second control, the TabOrder value for all the other controls changes. For example, suppose a control is sixth in the tab order. If you change the control’s TabOrder property value to 3 (making the control fourth in the tab order), the control that was originally fourth in the tab order now becomes fifth, and the control that was fifth becomes sixth. Assigning TabOrder a value greater than the number of controls contained in the parent control moves the control to the end of the tab order. The control does not take on the assigned value of TabOrder, but instead is given the number that assures the control is the last in the tab order.

Note: TabOrder is meaningful only if the TabStop property is True and if the control has a parent. (The TabOrder property of a form is not used unless the form is the child of another form.) A control with a TabOrder of -1 has no parent, and therefore cannot be reached by pressing the Tab key. To remove a parented control from the Tab order, set its TabStop property to False.

TabStop#

Determines whether the user can tab to a control. Use the TabStop to allow or disallow access to the control using the Tab key. If TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user cannot press the TAB key to move to the control.

Note: TabStop is not meaningful for a form unless the form assigns another form to be its parent.

ThumbColor#

The color of the toggle switch thumb. Default is clWindowText.

ThumbWidth#

The width of the thumb inside the toggle switch frame.

Update()#

Processes any pending paint messages immediately.

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.