ToolBar

Inheritance Hierarchy

          IComponent

          IControl

          IUiBar

          IToolBar

          ToolBar

Description

The ToolBar component realizes a standard toolbar containing buttons and drop-down lists.

Working with the Component

To edit the controls located on the toolbar list the component context menu items are used. The controls properties settings is performed in the object inspector. All buttons are of the same size but for the drop-down lists the width can be changed in the  Width property. It is possible to set up common properties for a group of buttons or drop-down lists. To do so hold the CTRL key, select the necessary buttons (drop-down menus) and change the necessary properties in the object inspector.

On work with the toolbar by the applied code a controls list can be created using the  Controls property. This collection is formed from the  ToolBarButton  and  ToolbarComboBox object class instances.

Hotkeys

You can appoint one or several hotkey combinations for toolbar buttons. To assign hotkeys in the form designer mode, it is necessary to select an action, select the  ShortCut  property in object inspector and press the required combination. Additional hotkey combinations are set in the collection  AdditionalShortCuts  using Fore language when executing the form.

Example

Properties of the ToolBar Component

  Property name Brief description
Align The Align property determines the behavior of the component, when the size of its parent component is changed.
AllowClose The AllowClose property determines whether the toolbar can be closed, if the panel is not embedded into a form, but located independently in the form region.
AllowDrag The AllowDrag property determines whether an object can be dragged from the component.
AllowDrop The AllowDrop property determines whether the component can accept a dragged object.
AllowUndock The AllowUndock property determines, whether it is possible to undock the toolbar during execution.
Anchors The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
Brush The Brush property specifies the brush used to fill the component area.
ClientHeight The ClientHeight property is used to receive or specify the height of the component’s client space.
ClientWidth The ClientWidth property is used to receive or specify the width of the component’s client space.
Color The Color property determines the background color of a component.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns the child component.
Controls The Controls property returns the collection of controls on the toolbar.
Cursor The Cursor property determines the look of the cursor over the component.
Data The Data property stores any custom data.
Edge The Edge property determines the position of a toolbar on a form.
Enabled The Enabled property determines whether the component is available for the user.
ExclusiveRow The ExclusiveRow property determines, whether several components can be located in one row.
Floating The Floating property determines, whether a toolbar should be floating or embedded.
Focused The Focused property returns True, if the focus is set on the component.
Font The Font property determines the set of characteristics, describing the font, used to display text.
Height The Height property determines the component height.
HelpContext The HelpContext property determines a unique index for the context help section for this component.
Hint The Hint property determines the hint text for the component.
Id The Id property determines the toolbar unique identifier.
Images The Images property determines the  ImageList  component, the images of which are displayed on the panel buttons.
Left The Left property determines the coordinate of the left border of the component.
MaxHintWidth The MaxHintWidth property determines the maximum width of a hint.
Name The Name property determines the component name.
Parent The Parent property determines the parent component.
ParentColor The ParentColor property determines whether the component inherits the color of the parent component.
ParentFont The ParentFont property determines whether the component should use the font of the parent component.
ParentShowHint The ParentShowHint property determines when a tooltip is displayed.
PopupMenu The PopupMenu property determines the context menu to be displayed on right-click.
Scrolls The Scrolls property returns parameters of component's scrollbars.
ShowCaptions The ShowCaption property determines, whether the captions of the user toolbar buttons should be displayed.
ShowHint The ShowHint property enables and disables showing a hint for the component.
TabOrder The TabOrder property determines the component position in the tab order.
TabStop The TabStop property determines whether the focus is set to a component when the TAB button is pressed.
Tag The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as required.
Text The Text property determines the row identifying a component for user.
Top The Top property determines the coordinate of the top border of the component.
Visible The Visible property determines the visibility of the component during execution.
Width The Width property determines the component width.

Methods of the ToolBar Component

  Method name Brief description
BeginUpdate The BeginUpdate method prohibits redrawing of the ToolBar component.
BringToFront The BringToFront method brings a component to front.
ClientToScreen The ClientToScreen method converts point coordinates relative to component coordinates into display coordinates.
Dock The Dock method binds the ToolBar component to a form.
DockLeftOf The DockLeftOf method binds ToolBar to a form and places the component on the left of the object passed as an input parameter.
DoDragDrop The DoDragDrop method starts drag-and-drop operation.
EndUpdate The EndUpdate method disables the mode, when redrawing of the ToolBar component is prohibited.
Float The Float method places the ToolBar component on a form as a separate box.
GetImage The GetImage method returns the image of the component with all the child components.
ScreenToClient The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
SendToBack The SendToBack method sends a component to back.
SetFocus The SetFocus method sets focus to this component.

Events of the ToolBar Component

  Event name Brief description
OnBeginDrag The OnBeginDrag event occurs for a component, when a user starts to drag an object from the component.
OnClick The OnClick event occurs if a user clicks a component area using the main mouse button.
OnDblClick The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
OnDragDrop The OnDragDrop event occurs for a component if a user drops a dragged object over it.
OnDragEnter The OnDragEnter event occurs when a dragged object crosses the borders of this component.
OnDragLeave The OnDragLeave event occurs when a dragged object leaves the borders of this component.
OnDragOver The OnDragOver event occurs for this component when a user drags a dragged object over it.
OnEnter The OnEnter event occurs when a component receives focus.
OnExit The OnExit event occurs when a component loses focus.
OnHScroll The OnHScroll event occurs when the horizontal scrollbar slider changes its position.
OnKeyDown The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
OnKeyPress The OnKeyPress event occurs if a component is focused when a user presses a character key.
OnKeyPreview The OnKeyPreview event occurs prior to each event requiring clicking.
OnKeyUp The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
OnMouseDown The OnMouseDown event occurs when the pointer is in component area and a mouse button is pressed.
OnMouseEnter The OnMouseEnter event occurs when mouse cursor enters the component area.
OnMouseHover The OnMouseHover event occurs when mouse cursor is held in the component area.
OnMouseLeave The OnMouseLeave event occurs when mouse cursor leaves the component area.
OnMouseMove The OnMouseMove event occurs on moving the cursor over component.
OnMouseUp The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
OnMouseWheel The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
OnVScroll The OnVScroll event occurs when the vertical scrollbar slider changes its position.

See also:

Additional Components