Xojo Documentation Xojo Documentation

Class (inherits from Object)

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

Events

Action DropDownMenuAction Close Open

Properties

AllowAutoDeactivate Left Transparent AllowTabStop Name TrueWindow Enabled Parent Visible Handle Tooltip Width Height Top Window

Methods

AcceptFileDrop AddButtonAt Invalidate AcceptPictureDrop ButtonAt Refresh AcceptRawDataDrop Close RemoveButtonAt AcceptTextDrop Count SetFocus AddButton DrawInto

Notes

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.ButtonStyle.PushButton
OpenButton.Style = ToolbarButton.ButtonStyle.PushButton

// add to the Toolbar
Me.Add(OpenButton)
Me.Add(SaveButton)

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.