Class

WebToolbarButton

Toolbar

ToolbarButton

Description

A button control in a WebToolbar.

Properties

Name	Type	Read-Only	Shared
Badge	String
Caption	String
Enabled	Boolean
Icon	WebPicture
Menu	WebMenuItem
Pressed	Boolean
Style	ButtonStyles
Tag	Variant
Tooltip	String
Visible	Boolean

Methods

Name	Parameters	Returns	Shared
Constructor	caption As String

Enumerations

WebToolbarButton.ButtonStyles

ButtonStyles

The various appearances a toolbar button can have.

Enum

Description

FlexibleSpace

The WebToolbarButton is a variable-width space between WebToolbarButtons. It right-aligns the buttons to its right as the window is resized.

Label

The WebToolbarButton is a standard WebLabel control.

Menu

The WebToolbarButton is a drop-down menu with a separate down arrow on its right. There is room for the caption and the icon. To specify the menu, assign it to the Menu property of the WebToolbarButton class. Handle the selected menu item in the MenuSelected event of the WebToolbar class.

PushButton

The WebToolbarButton is a pushbutton.

SeparateMenu

Same as the Menu type above. This is here for consistency with the desktop DesktopToolbarButton.ButtonStyles enumeration.

Separator

Not available for web projects.

Space

The WebToolbarButton is a fixed-width space between WebToolbarButtons.

Toggle

The WebToolbarButton is a button that toggles between its normal and depressed state. Pressing one changes the state of the other toggle buttons, effectively making them work similarly to RadioButtons.

Property descriptions

WebToolbarButton.Badge

Badge As String

A small graphical element used to displayed additional information alongside the WebToolbarItem.

The text appears in white on a round rectangle with a red background.

WebToolbarButton.Caption

Caption As String

The text that accompanies the WebToolbarItem to indicate its purpose.

WebToolbarButton.Enabled

Enabled As Boolean

If True, the item can be pressed. If False, it cannot be.

WebToolbarButton.Icon

Icon As WebPicture

The picture that is associated with the WebToolbarItem.

WebToolbarButton.Menu

Menu As WebMenuItem

This property accepts a WebMenuItem instance to display as a contextual menu when the button is pressed, or Nil to remove any associated contextual menu.

WebToolbarButton.Pressed

Pressed As Boolean

If True, the button appears pressed.

WebToolbarButton.Style

Style As ButtonStyles

The style or type of button.

WebToolbarButton.Tag

Tag As Variant

A hidden value associated with the WebToolbarItem.

Since this is a Variant, this can be used to associate any type of data, even an object, with the WebToolbarItem.

WebToolbarButton.Tooltip

Tooltip As String

A helpful message that describes the purpose of the WebToolbarItem.

WebToolbarButton.Visible

Visible As Boolean

Indicates whether or not the WebToolbarItem is visible.

This property is useful when you need to hide/show WebToolbarItem's dynamically at runtime.

Method descriptions

WebToolbarButton.Constructor

Constructor(caption As String)

Creates a new WebToolbarButton with the caption passed.

Notes

This item is similar to a normal toolbar button on the desktop. Pressing a button fires the Pressed event. It can appear in a pressed style that makes it appear selected.

Compatibility

Project Types	Web
Operating Systems	All