ToolBarToggleButton

Use

This UI element provides a toggle button to switch within a ToolBar.

Example of the Visual Display

Runtime Class

CL_WD_TOOLBAR_TOGGLE_BTN

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

collapsible

WDY_BOOLEAN

false

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

hotkey

WDY_BOOLEAN

true

Yes

imageFirst

WDY_BOOLEAN

true

Yes

imageSource

STRING

Yes

styleClassName 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

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

collapsible

COLLAPSIBLE

WDY_BOOLEAN

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

design

DESIGN

WDUI_TOGGLE_BUTTON_DESIGN

design: standard

CL_WD_TOOLBAR_TOGGLE_BTN=>E_DESIGN-STANDARD

design: toggle

CL_WD_TOOLBAR_TOGGLE_BTN=>E_DESIGN-TOGGLE

enabled

ENABLED

WDY_BOOLEAN

hotkey

HOTKEY

WDUI_HOTKEY

hotkey: alt_arrow_down

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ALT_ARROW_DOWN

hotkey: alt_arrow_left

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ALT_ARROW_LEFT

hotkey: alt_arrow_right

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ALT_ARROW_RIGHT

hotkey: alt_arrow_up

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ALT_ARROW_UP

hotkey: ctrl_0

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_0

hotkey: ctrl_1

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_1

hotkey: ctrl_2

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_2

hotkey: ctrl_3

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_3

hotkey: ctrl_4

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_4

hotkey: ctrl_5

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_5

hotkey: ctrl_6

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_6

hotkey: ctrl_7

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_7

hotkey: ctrl_8

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_8

hotkey: ctrl_9

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_9

hotkey: ctrl_a

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_A

hotkey: ctrl_b

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_B

hotkey: ctrl_c

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_C

hotkey: ctrl_comma

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_COMMA

hotkey: ctrl_d

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_D

hotkey: ctrl_dot

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_DOT

hotkey: ctrl_e

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_E

hotkey: ctrl_f

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F

hotkey: ctrl_f10

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F10

hotkey: ctrl_f11

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F11

hotkey: ctrl_f12

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F12

hotkey: ctrl_f2

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F2

hotkey: ctrl_f3

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F3

hotkey: ctrl_f4

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F4

hotkey: ctrl_f5

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F5

hotkey: ctrl_f6

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F6

hotkey: ctrl_f7

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F7

hotkey: ctrl_f8

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F8

hotkey: ctrl_f9

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_F9

hotkey: ctrl_g

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_G

hotkey: ctrl_h

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_H

hotkey: ctrl_i

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_I

hotkey: ctrl_j

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_J

hotkey: ctrl_k

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_K

hotkey: ctrl_l

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_L

hotkey: ctrl_m

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_M

hotkey: ctrl_n

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_N

hotkey: ctrl_o

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_O

hotkey: ctrl_p

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_P

hotkey: ctrl_q

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_Q

hotkey: ctrl_r

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_R

hotkey: ctrl_s

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_S

hotkey: ctrl_shift_f1

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F1

hotkey: ctrl_shift_f10

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F10

hotkey: ctrl_shift_f11

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F11

hotkey: ctrl_shift_f12

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F12

hotkey: ctrl_shift_f2

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F2

hotkey: ctrl_shift_f3

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F3

hotkey: ctrl_shift_f4

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F4

hotkey: ctrl_shift_f5

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F5

hotkey: ctrl_shift_f6

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F6

hotkey: ctrl_shift_f7

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F7

hotkey: ctrl_shift_f8

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F8

hotkey: ctrl_shift_f9

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_SHIFT_F9

hotkey: ctrl_t

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_T

hotkey: ctrl_u

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_U

hotkey: ctrl_v

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_V

hotkey: ctrl_w

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_W

hotkey: ctrl_x

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_X

hotkey: ctrl_y

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_Y

hotkey: ctrl_z

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-CTRL_Z

hotkey: delete

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-DELETE

hotkey: enter

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ENTER

hotkey: escape

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-ESCAPE

hotkey: insert

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-INSERT

hotkey: none

CL_WD_TOOLBAR_TOGGLE_BTN=>E_HOTKEY-NONE

imageFirst

IMAGE_FIRST

WDY_BOOLEAN

imageSource

IMAGE_SOURCE

STRING

styleClassName STYLE_CLASS_NAME STRING

text

TEXT

WDY_MD_TRANSLATABLE_TEXT

textDirection

TEXT_DIRECTION

WDUI_TEXT_DIRECTION

textDirection inherit

CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-INHERIT

textDirection ltr

CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-LTR

textDirection rtl

CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-RTL

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_TOOLBAR_TOGGLE_BTN=>E_VISIBLE-NONE

visible: visible

CL_WD_TOOLBAR_TOGGLE_BTN=>E_VISIBLE-VISIBLE

width

WIDTH

STRING

Dynamic Programming of Events

View Designer Name

Runtime Name

onToggle

ON_TOGGLE

Example

You can find an example of this UI element in the system in the WDR_TEST_UI_ELEMENTS Web Dynpro application.