TrackBar¶
Qualified name: delphivcl.TrackBar
- class TrackBar¶
Bases:
WinControl
TTrackBar is a wrapper for a track bar control. Use TTrackBar to put a track bar on a form. A track bar represents a position along a continuum using a slider and, optionally, tick marks. A track bar can also display a selected range marked by triangular ticks at the starting and ending positions of the selection. During program execution, the slider can be moved to the desired position by dragging it with the mouse or by clicking the mouse on the bar. To use the keyboard to move the slider, press the arrow keys or the Page Up and Page Down keys.
Methods
Indicates whether a control can receive focus.
Gives the input focus to the control.
Adds a tick mark to the track bar at a specified location.
Attributes
Action
Specifies the action associated with the control.
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.
Specifies how the control is anchored to its parent.
BiDiMode
Specifies the bidirectional mode for the control.
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.
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
Returns the owned component count
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
Returns an iterator over the owned components
Specifies the size constraints for the control.
Returns the count of contained controls
ControlState
Specifies the current state of a control at run time.
ControlStyle
Determines style characteristics of the control.
Returns an iterator over contained controls
Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
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
Control:
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.
Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
DoubleBufferedMode:
Specifies the image used to represent the mouse pointer when the control is being dragged.
Specifies whether the control is being dragged normally or for docking.
Specifies how the control initiates drag-and-drop or drag-and-dock operations.
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.
Determines whether the control has input focus.
Specifies the increment between tick marks on the track bar.
Provides access to the underlying Windows screen object for the control.
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.
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.
Indicates the amount the value of Position changes when the user presses the arrow keys.
Margins
Specifies the margins of the control.
Specifies the maximum Position of a TTrackBar.
Specifies the minimum Position of a TTrackBar.
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.
Callable[[Object, Object, int, int], None]:
Callable[[Object, Object, int, int, DragState, bool], None]:
Callable[[Object, Object, int, int], None]:
Callable[[Object, Object, int, int], None]:
Callable[[Object, GestureEventInfo, bool], None]:
Callable[[Object, DragDockObject], None]:
Callable[[Object, DragObject], None]:
Specifies whether the track bar is horizontal or vertical.
Owner
Returns the Component Owner
Padding
Specifies the padding of a control.
Specifies the amount Position is changed when the PageUp or PageDown key is pressed, or when the bar is clicked.
Parent
Returns/Sets the Control Parent
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 defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
Specifies where a control looks to find out if its Help Hint should be shown.
Reference to parent's underlying control.
PixelsPerInch
Embarcadero Technologies does not currently have any additional information.
Specifies the pop-up menu associated with the control.
Contains the current position of the slider of a TTrackBar.
Determines the position of the (optional) Tool Tip displaying the position of the track bar.
RedrawDisabled
RedrawDisabled property returns True when redrawing for this control is locked.
ScaleFactor
Embarcadero Technologies does not currently have any additional information.
Specifies the position of the end point of the selection range.
Specifies the position of the starting point of the selection range.
ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
Specifies whether the track bar shows the selection range.
Indicates whether the control is showing on the screen.
Specifies whether the track bar's slider is visible.
Specifies the style elements that are used by the control.
Embarcadero Technologies does not currently have any additional information.
TBDockHeight
Specifies the height of the control when it is docked vertically.
Indicates the position of the control in its parent's tab order.
Determines whether the user can tab to a control.
Tag
Stores a NativeInt integral value as a part of a component.
Specifies the length of the track bar's slider.
Specifies the location of the tick marks.
Specifies how tick marks are placed on the track bar.
Top
Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
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.
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.
- 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.
- Type:
Align
- 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.
- Type:
Anchors
- 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.
- Type:
int
- CanFocus()¶
Indicates whether a control can receive focus.
- 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.
- Type:
SizeConstraints
- ControlCount¶
Returns the count of contained controls
- Controls¶
Returns an iterator over contained controls
- Ctl3D¶
Determines whether a control has a three-dimensional (3-D) or two-dimensional look. Ctl3D is provided for backward compatibility. It is not used by 32-bit versions of Windows or NT4.0 and later, with the exception of Windows XP Home, where it is used on occasion. On earlier platforms, Ctl3D controlled whether the control had a flat or beveled appearance.
Note RAD Studio no longer supports Windows Vista or earlier.
- Type:
bool
- 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.
- Type:
bool
- DoubleBufferedMode¶
DoubleBufferedMode:
- 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.
- Type:
int
- 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.
- Type:
DragKind
- 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.
- Type:
DragMode
- 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.
- Type:
bool
- Focused¶
Determines whether the control has input focus.
- Frequency¶
Specifies the increment between tick marks on the track bar. Use Frequency to specify the spacing of the tick marks, using the logical units used by the Position property. For example, a Frequency of 5 sets a tick mark at every fifth possible increment. To provide visual feedback about the units used by the track bar, set Frequency to LineSize or PageSize.
Note: If the value of the TickStyle property is not set to tsAuto, the value of Frequency is ignored.
- Type:
int
- Handle¶
Provides access to the underlying Windows screen object for the control.
- HandleAllocated¶
Reports whether a screen object handle exists for the control.
- LineSize¶
Indicates the amount the value of Position changes when the user presses the arrow keys. Use LineSize to specify the distance along the slider that represents a single unit. The current Position is marked by a slider. The right and down arrow keys increment the value of Position by LineSize, and the left and up arrow keys decrement the value of Position by LineSize. Use the PageSize property to set the number of ticks moved using the Page Up and Page Down keys.
- Type:
int
- Max¶
Specifies the maximum Position of a TTrackBar. Use Max to set an upper limit to the value that can be represented using the track bar. A slider indicates the current Position in a range between Min and Max.
- Type:
int
- Min¶
Specifies the minimum Position of a TTrackBar. Use Min to set a lower limit to the value that can be represented using the track bar. A slider indicates the current Position in a range between Min and Max.
- Type:
int
- OnDragDrop¶
Callable[[Object, Object, int, int], None]:
- OnDragOver¶
Callable[[Object, Object, int, int, DragState, bool], None]:
- OnEndDock¶
Callable[[Object, Object, int, int], None]:
- OnEndDrag¶
Callable[[Object, Object, int, int], None]:
- OnGesture¶
Callable[[Object, GestureEventInfo, bool], None]:
- OnStartDock¶
Callable[[Object, DragDockObject], None]:
- OnStartDrag¶
Callable[[Object, DragObject], None]:
- Orientation¶
Specifies whether the track bar is horizontal or vertical. Set Orientation to the desired orientation of the track bar. Orientation has these possible values:
Value
Meaning
tbHorizontal
The long edge of the track is parallel to the top of the form. The Min position is on the left and the Max position is on the right.
tbVertical
The long edge of the track is parallel to the side of the form. The Min position is on the top and the Max position is on the bottom.
- Type:
TrackBarOrientation
- PageSize¶
Specifies the amount Position is changed when the PageUp or PageDown key is pressed, or when the bar is clicked. Set PageSize to the distance along the track bar that corresponds to a single view. A slider marks the current Position. The Page Up key increments the value of Position by PageSize, and Page Down key decrements the value of Position by PageSize. Use the LineSize property to set the number of ticks moved using the arrow keys.
- Type:
int
- 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.
- Type:
bool
- 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.
- Type:
bool
- 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.
- Type:
bool
- 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.
- Type:
- Position¶
Contains the current position of the slider of a TTrackBar. Read Position to determine the current value represented by the track bar. Position is a value in the range between Min and Max (inclusive). Set Position to programmatically move the slider of the track bar to a new value.
- Type:
int
- PositionToolTip¶
Determines the position of the (optional) Tool Tip displaying the position of the track bar. You can set this property to one of the following values.
Value
Meaning
ptNone
No Tool Tip is shown.
ptTop
The Tool Tip appears at the top side of the TrackBar.
ptBottom
The Tool Tip appears at the bottom side of the TrackBar.
ptLeft
The Tool Tip appears at the left side of the TrackBar.
ptRight
The Tool Tip appears at the right side of the TrackBar.
Note: Use ptLeft and ptRight for the vertical Track Bars. Use ptTop and ptBottom for the horizontal Track Bars.
- Type:
PositionToolTip
- SelEnd¶
Specifies the position of the end point of the selection range. Set SelEnd to determine the length of a selection that begins at SelStart. The track bar indicates a selection range on the bar by placing special tick marks at the positions specified by the SelStart and SelEnd properties and highlighting the selected portion of the bar. SelEnd must be greater than or equal to Position. If SelEnd is set to a value less than Position, Position changes to SelEnd. SelEnd must be greater than or equal to SelStart. If SelEnd is the same as SelStart, there is no selection, and the value of Position is the same as SelStart and SelEnd.
- Type:
int
- SelStart¶
Specifies the position of the starting point of the selection range. Set SelStart to determine the beginning of a selection that runs to SelEnd. The track bar indicates a selection range on the bar by placing special tick marks at the positions specified by the SelStart and SelEnd properties and highlighting the selected portion of the bar. SelStart must be less than or equal to Position. If SelStart is set to a value greater than Position, Position changes to SelStart. SelStart must be less than or equal to SelEnd. If SelStart is the same as SelEnd, there is no selection, and the value of Position is the same as SelStart and SelEnd.
- Type:
int
- SetFocus()¶
Gives the input focus to the control.
- SetTick(Value: int) None ¶
Adds a tick mark to the track bar at a specified location. Use SetTick to place a tick mark on the bar at the position that corresponds to the Value parameter. Tick marks specified in this manner are only displayed when the TickStyle is set to tsManual.
- 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.
- Type:
bool
- ShowSelRange¶
Specifies whether the track bar shows the selection range. If set to True, the selection range on the track bar is displayed. If set to False, the selection range is not displayed.
- Type:
bool
- Showing¶
Indicates whether the control is showing on the screen.
- SliderVisible¶
Specifies whether the track bar’s slider is visible. Use SliderVisible to get or set whether the track bar’s slider is visible.
- Type:
bool
- 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.
- Type:
StyleElements
- StyleName¶
Embarcadero Technologies does not currently have any additional information.
- Type:
str
- 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.
- Type:
int
- 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.
- Type:
bool
- ThumbLength¶
Specifies the length of the track bar’s slider. Use ThumbLength to get or set the length of the track bar’s slider.
- Type:
int
- TickMarks¶
Specifies the location of the tick marks. Set TickMarks to specify where the tick marks should be drawn. TickMarks has these possible values:
Value
Meaning
tmBottomRight
Tick marks are on the bottom or right of the track bar, depending of the value of Orientation.
tmTopLeft
Tick marks are on the top or left of the track bar, depending of the value of Orientation.
tmBoth
Tick marks are on both sides of the track bar.
If the TickStyle property is tsNone, the value of TickMarks is ignored.
- Type:
TickMark
- TickStyle¶
Specifies how tick marks are placed on the track bar. Set TickStyle to specify whether the track bar should display tick marks, and if so, how those tick marks are set. TickStyle has these possible values:
Value
Meaning
tsAuto
Tick marks are automatically displayed at increments equal to the value of the Frequency property.
tsManual
Tick marks are displayed at the Min and Max values. Additional tick marks can be set using the SetTick method.
tsNone
No tick marks are displayed.
- Type:
TickStyle
- 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.
- Type:
TouchManager
- 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.
- Type:
bool