ToolBarToggleButton  

Definition

A ToolBarToggleButton is a ToggleButton especially for a ToolBar. In addition it can be collapsed.

Description of UI Element Properties

●      activateAccessKey

Indicates whether access key for this control is activated. More information: Enabling Access Keys

●      checked

Specifies whether or not the ToolBarToggleButton is toggled.

●      checkedImageSource

Specifies the Web address of the icon that appears when the ToolBarToggleButton is toggled.

●      collapsible

Specifies whether the ToolBar element can be collapsed. A little icon is displayed in a ToolBar which contains those elements. When the user selects this icon, all toolbar elements with the collapsible property set to true are hidden.

●      design

The design property can be filled with the following values and is represented by the enumeration type WDToggleButtonDesign.

standard	Displays the ToolBarToggleButton with the default colors for the background and text. When values are assigned to the properties imageSource and checkedImageSource, the corresponding icon is displayed.
toggle	Displays the ToolBarToggleButton with a triangle symbol: If the ToolBarToggleButton is toggled, the triangle points down: If you select this value, no further icons should be assigned.

●      hotkey

Specifies the key combination that triggers the onAction event. The value is defined as

enumeration type WDHotkey.

●      imageFirst

Defines the position of the icon in relation to the corresponding text. If the value of this property is true, the icon is displayed to the left of the text.

●      imageSource

Specifies the Web address (URL) of the graphic to be displayed.

●      text

Specifies the text to be assigned to the ToolBarToggleButton.

●      textDirection

Specifies the text direction and allows you to use the toggle element for texts in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.

inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
ltr	The text runs from left to right.
rtl	The text runs from right to left.

The default value for this property is inherit.

●      width

Specifies the width of the ToolBarToggleButton. You can specify the width in CSS units like em, ex, pixel, or percentage.

Properties Overview

Name	Interface	Type	Initial Value	Bindable
activateAccessKey	IWDAbstractToggle	boolean	false	not bindable
checked	IWDAbstractToggle	boolean	false	bindable_mandatory
checkedImageSource	IWDAbstractToggleButton	String		bindable
collapsible	IWDToolBarToggleButton	boolean	false	bindable
design	IWDAbstractToggleButton	WDToggleButtonDesign	standard	bindable
enabled	IWDUIElement	boolean	true	bindable
hotkey	IWDToolBarToggleButton	WDHotkey	none	not bindable
imageFirst	IWDAbstractToggleButton	boolean	true	bindable
imageSource	IWDAbstractToggleButton	String		bindable
text	IWDAbstractToggleButton	String		bindable
textDirection	IWDAbstractToggle	WDTextDirection	inherit	bindable
tooltip	IWDUIElement	String		bindable
visible	IWDUIElement	WDVisibility	visible	bindable
width	IWDAbstractToggleButton	String		bindable

Events

The onToggle event is triggered when the ToolBarToggleButton is toggled. The parameter is of the type boolean and transfers the new status.

Name	Class	Parameter
onToggle	IWDAbstractToggle	(boolean checked)