Show TOC Start of Content Area

Object documentation ToggleButton This graphic is explained in the accompanying text  Locate the document in its SAP Library structure

Definition

●      checked

Specifies whether or not the ToggleButton is toggled.

●      checkedImageSource

defines the path to the image source.

See: Specifying the Image Source

●      design

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

standard

Displays the ToggleButton 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 ToggleButton with a triangle symbol: This graphic is explained in the accompanying text
If the ToggleButton is toggled, the triangle points down: This graphic is explained in the accompanying text
If you select this value, no further icons should be assigned.

●      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

defines the path to the image source.

See: Specifying the Image Source

●      text

Specifies the text to be assigned to the ToggleButton.

●      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 take the following values and is represented by 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 ToggleButtons. You can specify the width in CSS units like em, ex, pixel, or percentage.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

checked

IWDAbstractToggle

boolean

false

bindable_mandatory

checkedImageSource

IWDAbstractToggleButton

String

 

bindable

design

IWDAbstractToggleButton

WDToggleButtonDesign

standard

bindable

enabled

IWDUIElement

boolean

true

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 ToggleButton is toggled. The parameter is the new status of the element.

Name

Class

Parameter

onToggle

IWDAbstractToggle

(boolean checked)

 

End of Content Area