Class # ToolItem (deprecated) ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Warning

This item was deprecated in version 2019r2. Please use `ToolbarItem` as a replacement.

## Description An item in a `Toolbar`. An item is a style of `ToolbarButton`. Create each item with the `ToolbarButton` class and add each item to a `Toolbar` via the Append or Insert methods. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------|------------------------------------|-----------|--------| | `Caption` | `String` | | | | `Enabled` | `Boolean` | | | | `HelpTag` | `String` | | | | `Name` | `String` | | | | `Tag` | `Variant` | | | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ToolItem.Caption **Caption** As `String`

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ToolItem.Enabled **Enabled** As `Boolean` `True` if the ToolItem is enabled.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ToolItem.HelpTag **HelpTag** As `String` The help tip that is displayed when the pointer is over the ToolItem.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ToolItem.Name **Name** As `String` The name of the ToolItem.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ToolItem.Tag **Tag** As `Variant` A “hidden” value associated with the tool item. The tag is accessible via code when the user chooses the tool item but, unlike the Caption property, is not displayed in the toolbar. This example is in the Toolbar Open event of the main window. ``` xojo Me.SaveButton.Tag = folderItemToSave ``` ## Compatibility All project types on all supported operating systems. ## See also `Object` parent class; `Toolbar`, `ToolbarButton` classes.