ToolBar

Qualified name: delphivcl.ToolBar

class ToolBar

Bases: WinControl

TToolBar manages tool buttons and other controls, arranging them in rows and automatically adjusting their sizes and positions. TToolBar is a container for tool buttons (TToolButton). It provides an easy way to arrange and manage visual controls. All tool buttons on a toolbar maintain a uniform width and height. Other controls can sit on a toolbar. These controls (which are held in place by invisible tool buttons) maintain a uniform height. Controls can automatically wrap around and start a new row when they do not fit horizontally on the toolbar. The Flat property allows the background to show through the toolbar and gives pop-up borders to the tool buttons. Spaces and dividers (which are in fact specially configured tool buttons) can group controls on the toolbar both visually and functionally. Typically, the tool buttons correspond to items in an application’s menu and give the user more direct access to the application’s commands.

Methods

CanFocus	Indicates whether a control can receive focus.
FlipChildren	Prevents the toolbar buttons from reversing position when the parent control is flipped.
GetChildren	Allows the streaming system to load and save child controls in the order they appear in the toolbar.
GetEnumerator	Returns a TComponent enumerator.
SetFocus	Gives the input focus to the control.
TrackMenu	Called when the accelerator for a toolbar button is pressed.

Attributes

Action	Specifies the action associated with the control.
Actions	Lists the buttons of the toolbar.
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.
AllowTextButtons	Determines whether tool buttons that consist only of text can be placed on the Toolbar.
Anchors	Specifies how the control is anchored to its parent.
AutoSize	Specifies whether the control sizes itself automatically to accommodate its contents.
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.
ButtonCount	Indicates the number of buttons in the toolbar.
ButtonHeight	Specifies the height of the controls in the toolbar.
ButtonWidth	Specifies the width of the tool buttons (TToolButton) in the toolbar.
Buttons	ToolButton:
Canvas	Specifies the drawing surface for the toolbar.
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.
Color	Specifies the background color of the control.
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
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
Ctl3D	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.
Customizable	Specifies whether the user can customize the toolbar at runtime.
CustomizeKeyName	Specifies the registry key where the tool bar saves its current button configuration before the user changes it using the toolbar customize dialog.
CustomizeValueName	Specifies the registry value under which the tool bar saves its current button configuration before the user changes it using the toolbar customize dialog.
DesignInfo	Contains information used by the Form designer.
DisabledImages	Lists the images that can appear on disabled tool buttons.
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.
DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
DoubleBufferedMode	DoubleBufferedMode:
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.
DrawingStyle	Stores the style type.
EdgeBorders	EdgeBorders:
EdgeInner	EdgeStyle:
EdgeOuter	EdgeStyle:
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.
Flat	Makes the toolbar transparent and eliminates tool-button borders.
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.
GradientDirection	Specifies whether the direction of the gradient is horizontal or vertical.
GradientDrawingOptions	Stores the drawing option chosen.
GradientEndColor	Color used as end color for the gradient.
GradientStartColor	Color used as start color for the gradient.
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.
HideClippedButtons	Specifies handling of buttons obscured by adjacent toolbar.
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.
HotImages	Lists the images that can appear on tool buttons when the mouse points to them.
HotTrackColor	Color used as hot tracking color when in gradient style.
Images	Lists the images that can appear on tool buttons.
Indent	Specifies the margin on the left side of the toolbar.
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.
List	Aligns captions on the right and images on the left in tool buttons.
Margins	Specifies the margins of the control.
Menu	Causes the toolbar to populate itself with buttons that correspond to items in a menu.
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.
OnAdvancedCustomDraw	Callable[[ToolBar, Rect, CustomDrawStage, bool], None]:
OnAdvancedCustomDrawButton	Callable[[ToolBar, ToolButton, CustomDrawState, CustomDrawStage, TBCustomDrawFlags, bool], None]:
OnCustomDraw	Callable[[ToolBar, Rect, bool], None]:
OnCustomDrawButton	Callable[[ToolBar, ToolButton, CustomDrawState, bool], None]:
OnCustomizeAdded	Callable[[ToolBar, ToolButton], None]:
OnCustomizeCanDelete	Callable[[ToolBar, int, bool], None]:
OnCustomizeCanInsert	Callable[[ToolBar, int, bool], None]:
OnCustomizeDelete	Callable[[ToolBar, ToolButton], None]:
OnCustomizeNewButton	Callable[[ToolBar, int, ToolButton], None]:
OnDockDrop	Callable[[Object, DragDockObject, int, int], None]:
OnDockOver	Callable[[Object, DragDockObject, int, int, DragState, bool], None]:
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]:
OnGetSiteInfo	Callable[[Object, Control, Rect, Point, bool], None]:
OnMouseActivate	Callable[[Object, MouseButton, ShiftState, int, int, int, MouseActivate], None]:
OnStartDock	Callable[[Object, DragDockObject], None]:
OnStartDrag	Callable[[Object, DragObject], None]:
OnUnDock	Callable[[Object, Control, WinControl, bool], None]:
Owner	Returns the Component Owner
Padding	Specifies the padding of a control.
Parent	Returns/Sets the Control Parent
ParentColor	Specifies where a control looks for its color information.
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.
RowCount	Indicates the number of rows in the toolbar.
ScaleFactor	Embarcadero Technologies does not currently have any additional information.
ShowCaptions	Determines whether text captions are displayed on tool buttons.
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.
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.
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.
Transparent	Specifies whether the toolbar is transparent.
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.
Wrapable	Enables automatic line-wrap for components in the toolbar.

Actions

Lists the buttons of the toolbar.

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

AllowTextButtons

Determines whether tool buttons that consist only of text can be placed on the Toolbar. When set to true, the tbsTextButton style is available for the TToolButton control, allowing you to create tool buttons on the Toolbar that consist only of text. When set to false, the tbsTextButton style is not available for the TToolButton control.

Type:

bool

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

AutoSize

Specifies whether the control sizes itself automatically to accommodate its contents. Use AutoSize to specify whether the control sizes itself automatically. When AutoSize is True, the control resizes automatically when its contents change. By default, AutoSize is False.

Type:

bool

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

ButtonCount

Indicates the number of buttons in the toolbar.

ButtonHeight

Specifies the height of the controls in the toolbar. ButtonHeight represents the height, in pixels, of the controls in the toolbar.

Type:

int

ButtonWidth

Specifies the width of the tool buttons (TToolButton) in the toolbar. ButtonWidth represents the width, in pixels, of the TToolButton components on the toolbar. It has no effect on tool buttons whose Style property is set to tbsSeparator or tbsDivider.

Type:

int

Buttons

ToolButton:

CanFocus()

Indicates whether a control can receive focus.

Canvas

Specifies the drawing surface for the toolbar. Use Canvas to draw or paint on the surface of the toolbar in an OnCustomDraw or OnCustomDrawButton event handler. The TCanvas object provides the properties and methods needed for drawing and painting.

Type:

Canvas

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.

Type:

str

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.

Type:

int

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

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

Customizable

Specifies whether the user can customize the toolbar at runtime. Set Customizable to true to allow the user to add, delete, and move toolbar buttons at runtime. There are two ways the user can change a customizable toolbar: By holding the shift key, the user can drag a button to a new position on the tool bar, or drag it off the toolbar entirely to delete the button. By double-clicking on the toolbar, the user can display the toolbar customize dialog. The toolbar customize dialog shows all the possible buttons in two list boxes, one that contains buttons not on the tool bar, and one that contains buttons currently on the tool bar. The user can use this dialog to add or remove buttons and to change their order.

Note: When Customizable is true, a number of events inform the tool bar component when the user makes changes.

Type:

bool

CustomizeKeyName

Specifies the registry key where the tool bar saves its current button configuration before the user changes it using the toolbar customize dialog. Use CustomizeKeyName to specify where the toolbar saves its button configuration when the user first displays the toolbar customize dialog. This is a subkey of HKEY_CURRENT_USER. When the user double-clicks the tool bar to display the toolbar customize dialog, the tool bar receives an OnCustomizing event and then automatically saves its current configuration to this key using the name specified by the CustomizeValueName property. If the user instructs the dialog to restore this configuration, the toolbar fetches the saved configuration from this registry key.

Type:

str

CustomizeValueName

Specifies the registry value under which the tool bar saves its current button configuration before the user changes it using the toolbar customize dialog. Use CustomizeValueName to specify the name that the toolbar uses to save its button configuration when the user first displays the toolbar customize dialog. This is a value under the registry key specified by the CustomizeKeyName property. When the user double-clicks the tool bar to display the toolbar customize dialog, the tool bar receives an OnCustomizing event and then automatically saves its current configuration to the Registry using this value. If the user instructs the dialog to restore this configuration, the toolbar fetches this saved configuration.

Type:

str

DisabledImages

Lists the images that can appear on disabled tool buttons. DisabledImages contains a list of images that can appear on tool buttons when they are disabled. Each tool button’s ImageIndex property determines the specific image displayed on it. If DisabledImages is unassigned, disabled tool buttons display grayed versions of their regular images (specified by the Images property).

Type:

CustomImageList

DockSite

Specifies whether the control can be the target of drag-and-dock operations. Set DockSite to true to allow other controls to be docked to this windowed control.

Code Examples Docking (Delphi) Docking (C++)

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

DrawingStyle

Stores the style type. This property stores either the dsNormal or dsGradient style choice.

Type:

TBDrawingStyle

EdgeBorders

EdgeBorders:

EdgeInner

EdgeStyle:

EdgeOuter

EdgeStyle:

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

Flat

Makes the toolbar transparent and eliminates tool-button borders. If Flat is set to true, the toolbar and its tool buttons are transparent; background colors and graphics show through them. In addition, when Flat is true, tool buttons (TToolButton) on the toolbar have pop-up borders that appear only when the mouse is passed over the button.

Type:

bool

FlipChildren(AllLevels: bool) → None

Prevents the toolbar buttons from reversing position when the parent control is flipped. FlipChildren overrides the inherited method in order to prevent the flipping of the toolbar’s children.

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

Type:

Font

GetChildren(Proc: Callable[[Component], None], Root: Component) → None

Allows the streaming system to load and save child controls in the order they appear in the toolbar. GetChildren is introduced in TComponent for the streaming system that loads and saves VCL components. It executes the callback specified by Proc for all the button in the toolbar, as well as any other controls that have the toolbar as a parent and the component specified by Root as an Owner. Proc is a callback that the streaming system uses to load or save persistent objects on a form. Root is the the top-level component (such as a form or data module) that is currently being loaded or saved.

GetEnumerator()

Returns a TComponent enumerator. Vcl.ComCtrls.TToolBar.GetEnumerator inherits from System.Classes.TComponent.GetEnumerator. All content below this line refers to System.Classes.TComponent.GetEnumerator. Returns a TComponent enumerator. GetEnumerator returns a TComponentEnumerator reference, which enumerates the components contained within a specified containing component. To process all these subcomponents, call the TComponentEnumerator GetCurrent method within a While MoveNext do loop.

GradientDirection

Specifies whether the direction of the gradient is horizontal or vertical. This property stores the value for the gradient direction.

Type:

GradientDirection

GradientDrawingOptions

Stores the drawing option chosen. This property contains either the gdoHotTrack or gdoGradient option, depending on which one was chosen.

Type:

TBGradientDrawingOptions

GradientEndColor

Color used as end color for the gradient. This property stores the color that is used to paint the gradient when the drawing ends. (The end color blends with the start color).

Type:

int

GradientStartColor

Color used as start color for the gradient. The property stores the value that represents the drawing color when the gradient starts painting.

Type:

int

Height

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

Type:

int

HideClippedButtons

Specifies handling of buttons obscured by adjacent toolbar. If HideClippedButtons is set to true, any button partially obscured by a neighboring band is hidden.

Type:

bool

HotImages

Lists the images that can appear on tool buttons when the mouse points to them. HotImages contains a list of images that can appear on tool buttons when the mouse passes over them at runtime. Each tool button’s ImageIndex property determines the specific image displayed when the mouse points to it. If HotImages is unassigned, tool buttons retain their regular images (specified by the Images property) when pointed to. Use a TImageList control to hold the images that will be shown for hot images. Typically, then, the application will have two TImageList controls, one for the Images property and one for the HotImages property. To use HotImages set the Flat property to True.

Type:

CustomImageList

HotTrackColor

Color used as hot tracking color when in gradient style. This is the color used as the hot tracking color when the toolbar’s DrawingStyle property is set to dsGradient. The hot tracking color is the color the button turns when the mouse moves over it.

Type:

int

Images

Lists the images that can appear on tool buttons. Images contains a list of images that can appear on the toolbar’s tool buttons. Each tool button’s ImageIndex property determines the specific image displayed on it. If Images is unassigned, no images are displayed on the tool buttons. Images in the list should be 16x16.

Type:

CustomImageList

Indent

Specifies the margin on the left side of the toolbar. Indent specifies, in pixels, the margin that separates the left edge of the toolbar from the controls within it.

Type:

int

List

Aligns captions on the right and images on the left in tool buttons. When List is false, tool buttons (TToolButton) appear in the toolbar with their images (if any) centered and their captions (if visible) underneath. Setting List to true aligns captions to the right and images to the left.

Type:

bool

Menu

Causes the toolbar to populate itself with buttons that correspond to items in a menu. Use the menu property to populate the tool bar to match a menu component. Setting Menu causes the toolbar to delete all of its current buttons and replace them with tool buttons that match the items in the specified menu component. In applications that use Menu to populate the toolbar, do not change the Buttons property by adding, deleting, or editing toolbar buttons.

Note: The toolbar does not dynamically track any changes to the menu specified by Menu. That is, it sets the tool buttons to reflect the set of items in the menu at the point when the application sets this property, and ignores any subsequent changes.

Type:

MainMenu

OnAdvancedCustomDraw

Callable[[ToolBar, Rect, CustomDrawStage, bool], None]:

OnAdvancedCustomDrawButton

Callable[[ToolBar, ToolButton, CustomDrawState, CustomDrawStage, TBCustomDrawFlags, bool], None]:

OnCustomDraw

Callable[[ToolBar, Rect, bool], None]:

OnCustomDrawButton

Callable[[ToolBar, ToolButton, CustomDrawState, bool], None]:

OnCustomizeAdded

Callable[[ToolBar, ToolButton], None]:

OnCustomizeCanDelete

Callable[[ToolBar, int, bool], None]:

OnCustomizeCanInsert

Callable[[ToolBar, int, bool], None]:

OnCustomizeDelete

Callable[[ToolBar, ToolButton], None]:

OnCustomizeNewButton

Callable[[ToolBar, int, ToolButton], None]:

OnDockDrop

Callable[[Object, DragDockObject, int, int], None]:

OnDockOver

Callable[[Object, DragDockObject, int, int, DragState, bool], None]:

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]:

OnGetSiteInfo

Callable[[Object, Control, Rect, Point, bool], None]:

OnMouseActivate

Callable[[Object, MouseButton, ShiftState, int, int, int, MouseActivate], None]:

OnStartDock

Callable[[Object, DragDockObject], None]:

OnStartDrag

Callable[[Object, DragObject], None]:

OnUnDock

Callable[[Object, Control, WinControl, bool], None]:

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.

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

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.

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

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:

PopupMenu

RowCount

Indicates the number of rows in the toolbar. Reading RowCount returns the number of rows in which the tool buttons are arranged.

Type:

int

SetFocus()

Gives the input focus to the control.

ShowCaptions

Determines whether text captions are displayed on tool buttons. If ShowCaptions is set to true, tool buttons appear in the toolbar with their captions displayed. Setting ShowCaptions to true may increase the size of the tool buttons.

Type:

bool

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

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

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

TrackMenu(Button: ToolButton) → bool

Called when the accelerator for a toolbar button is pressed. TrackMenu is called automatically in response to the accelerator on a toolbar button. It initializes the menu of a drop-down menu button, and forwards a click to the underlying Windows control. Button is the toolbar button for which an accelerator was pressed. Override TrackMenu in a derived class to perform additional actions when the accelerator for a toolbar button is pressed.

Transparent

Specifies whether the toolbar is transparent. Use Transparent to get or set whether the toolbar is transparent. Note the Transparent property applies only to the toolbar itself not its buttons.

Tip: To avoid painting problems, set the Transparent property before the toolbar becomes visible.

Type:

bool

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

Wrapable

Enables automatic line-wrap for components in the toolbar. If Wrapable is true, components automatically wrap around and form new rows when they do not fit horizontally in the toolbar.

Type:

bool