ToggleButton

The UI element ToggleButton represents the pushbutton on the screen. The user can execute statements and actions by clicking the ToggleButton.

Note

To enable the development of accessible applications, the tooltip property is checked during the syntax check if the property text has not been set.

Example of the Visual Display

TOGGLEBUTTON

Runtime Class

CL_WD_TOGGLE_BUTTON

Properties in View Designer

Name	Type	Initial Value	Bindable
id	STRING	(automatic)	No
activateAccessKey	WDY_BOOLEAN	false	No
checked	WDY_BOOLEAN	false	Mandatory
checkedImageSource	STRING		Yes
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
design	WDUI_TOGGLE_BUTTON_DESIGN	standard	Yes
enabled	WDY_BOOLEAN	true	Yes
imageFirst	WDY_BOOLEAN	true	Yes
imageSource	STRING		Yes
text	Translatable text		Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
visible	WDUI_VISIBILITY	visible	Yes
width	STRING		Yes

Events in View Designer

Name
onToggle

Note

Other properties that can be inherited are defined in the related higher-level classes. The related UI elements are:

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. But note that the spelling format and use of upper/lower case is different.

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
activateAccessKey	ACTIVATE_ACCESS_KEY	WDY_BOOLEAN
checked	CHECKED	WDY_BOOLEAN
checkedImageSource	CHECKED_IMAGE_SOURCE	STRING
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_TOGGLE_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_TOGGLE_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_TOGGLE_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
design	DESIGN	WDUI_TOGGLE_BUTTON_DESIGN
design: standard	CL_WD_TOGGLE_BUTTON=>E_DESIGN-STANDARD
design: toggle	CL_WD_TOGGLE_BUTTON=>E_DESIGN-TOGGLE
enabled	ENABLED	WDY_BOOLEAN
imageFirst	IMAGE_FIRST	WDY_BOOLEAN
imageSource	IMAGE_SOURCE	STRING
text	TEXT	WDY_MD_TRANSLATABLE_TEXT
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection inherit	CL_WD_TOGGLE_LINK=>E_TEXT_DIRECTION-INHERIT
textDirection ltr	CL_WD_TOGGLE_BUTTON=>E_TEXT_DIRECTION-LTR
textDirection rtl	CL_WD_TOGGLE_BUTTON=>E_TEXT_DIRECTION-RTL
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_TOGGLE_BUTTON=>E_VISIBLE-NONE
visible: visible	CL_WD_TOGGLE_BUTTON=>E_VISIBLE-VISIBLE
width	WIDTH	STRING

Dynamic Programming of Events

View Designer Name	Runtime Name
onToggle	ON_TOGGLE

Example

You can find examples in the system in the Web Dynpro application, WDR_TEST_UI_ELEMENTS.