From Xojo Documentation

You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!

Class (inherits from RectControl)

Used to create a toolbar in a window. The Toolbar control is supported on all desktop platforms.

Action DropDownMenuAction
Close Open
AllowAutoDeactivate Left Transparent
AllowTabStop Name fa-lock-32.png TrueWindow fa-lock-32.png
Enabled Parent Visible
Handle fa-lock-32.png Tooltip Width
Height Top Window fa-lock-32.png
AcceptFileDrop AddButtonAt Invalidate
AcceptPictureDrop ButtonAt Refresh
AcceptRawDataDrop Close RemoveButtonAt
AcceptTextDrop Count SetFocus
AddButton DrawInto


A Toolbar object contains all the buttons in a toolbar. You create the items in the toolbar with the ToolbarButton class and add them to the toolbar with the AddButton or AddButtonAt methods. An item can be either a button or a divider. A button can work as either a pushbutton or a toggle button.

For best results, you should ensure that all your toolbar icons are the same size. Some platforms will size all icons to that of the icon on the first button in the toolbar.
You can only have a single toolbar on a Window.

Mouse events

Although Toolbar inherits from RectControl, it has no mouse-related events. This is due to limitations of the operating system.

Sample Code

This example shows how to create a Toolbar via code. It builds a small Toolbar with Open and Save buttons. A Toolbar object was added to a window. The pictures that are displayed by the two buttons were added to the project.

The window has the following properties:

SaveButton As ToolbarButton
OpenButton As ToolbarButton

The following code is in the Open event of the Toolbar instance in the window.

SaveButton = New ToolbarButton
OpenButton = New ToolbarButton

SaveButton.Caption = "Save" // Caption appears below the Icon
SaveButton.Name = "Save"
SaveButton.icon = SaveButtonImage // image added to the project

OpenButton.Caption = "Open" // Caption appears below the Icon
OpenButton.Name = "Open"
OpenButton.Icon = OpenButtonImage // image added to the project
SaveButton.Style = ToolbarButton.ButtonStyles.PushButton
OpenButton.Style = ToolbarButton.ButtonStyles.PushButton

// add to the Toolbar

The following code is in the Action event of the Toolbar in the window:

Sub Action(item As ToolItem)
Select Case item.Name
Case "Open"
MessageBox("You clicked the Open Button.")
Case "Save"
MessageBox("You clicked the Save Button.")
End Select
End Sub

See Also

ToolbarButton, ToolbarItem classes.