Class

# WebToolbarItem

<div class="rst-class">

forsearch

</div>

Toolbar

<div class="rst-class">

forsearch

</div>

ToolbarItem

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

## Description

The parent class for all items that can go into a toolbar. It is an abstract class and is not intended to be subclassed by a developer.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                              | Type                                   | Read-Only | Shared |
|-----------------------------------|----------------------------------------|-----------|--------|
| `Badge<webtoolbaritem.badge>`     | `String</api/data_types/string>`       |           |        |
| `Caption<webtoolbaritem.caption>` | `String</api/data_types/string>`       |           |        |
| `Enabled<webtoolbaritem.enabled>` | `Boolean</api/data_types/boolean>`     |           |        |
| `Icon<webtoolbaritem.icon>`       | `WebPicture</api/graphics/webpicture>` |           |        |
| `Tag<webtoolbaritem.tag>`         | `Variant</api/data_types/variant>`     |           |        |
| `Tooltip<webtoolbaritem.tooltip>` | `String</api/data_types/string>`       |           |        |
| `Visible<webtoolbaritem.visible>` | `Boolean</api/data_types/boolean>`     |           |        |

## Property descriptions

<div id="webtoolbaritem.badge">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Badge

**Badge** As `String</api/data_types/string>`

> A small graphical element used to displayed additional information alongside the <span class="title-ref">WebToolbarItem</span>.
>
> The text appears in white on a round rectangle with a red background.

<div id="webtoolbaritem.caption">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Caption

**Caption** As `String</api/data_types/string>`

> The text that accompanies the <span class="title-ref">WebToolbarItem</span> to indicate its purpose.

<div id="webtoolbaritem.enabled">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Enabled

**Enabled** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the item can be pressed. If `False</api/language/false>`, it cannot be.

<div id="webtoolbaritem.icon">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Icon

**Icon** As `WebPicture</api/graphics/webpicture>`

> The `picture</api/graphics/webpicture>` that is associated with the <span class="title-ref">WebToolbarItem</span>.

<div id="webtoolbaritem.tag">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Tag

**Tag** As `Variant</api/data_types/variant>`

> A hidden value associated with the <span class="title-ref">WebToolbarItem</span>.
>
> Since this is a `Variant</api/data_types/variant>`, this can be used to associate any type of data, even an object, with the <span class="title-ref">WebToolbarItem</span>.

<div id="webtoolbaritem.tooltip">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Tooltip

**Tooltip** As `String</api/data_types/string>`

> A helpful message that describes the purpose of the <span class="title-ref">WebToolbarItem</span>.

<div id="webtoolbaritem.visible">

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

</div>

<div class="rst-class">

forsearch

</div>

WebToolbarItem.Visible

**Visible** As `Boolean</api/data_types/boolean>`

> Indicates whether or not the <span class="title-ref">WebToolbarItem</span> is visible.
>
> This property is useful when you need to hide/show <span class="title-ref">WebToolbarItem</span>'s dynamically at runtime.

## Compatibility

|                       |     |
|-----------------------|-----|
| **Project Types**     | Web |
| **Operating Systems** | All |

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `WebToolbar</api/user_interface/web/webtoolbar>` and `WebToolbarButton</api/user_interface/web/webtoolbarbutton>` classes.

</div>