Start of Content Area

Background documentation ToolBar  Locate the document in its SAP Library structure

A Toolbar UI element is a collection of tools that can be accessed using UI elements. Toolbars therefore provide an additional method of grouping UI elements functionally.

A toolbar can contain the following elements:

      ToolBarButton

      ToolBarButtonChoice

      ToolBarDropDownByIndex

      ToolBarDropDownByKey

      ToolBarInputField

      ToolBarLinkToAction

      ToolBarLinkToURL

      ToolBarLinkChoice

      ToolBarSeparator

      ToolBarToggleButton

Each individual element has the property collapsible, with which it can be hidden. All collapsible elements can be hidden using a small triangular symbol This graphic is explained in the accompanying text.

 

These toolbar elements are lined up in the toolbar in a single row. The size and position of each UI element is calculated automatically. You can use the property wrapping to determine whether a line break can be applied to the elements in a row.

 

To find out how to download a file without using the UI element, see File Export.

 

Note

To enable the development of accessible applications, the properties tooltip and accessbilityDescription are not checked during the syntax check.

A tooltip does not necessarily have to be set for this UI element, but it could make sense to set it if it contains detailed semantic information.

 

Runtime Class

CL_WD_TOOLBAR

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

id

STRING

(automatic)

No

accessibilityDescription

Translatable text

 

Yes

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

design

WDUI_TOOLBAR_DESIGN

standard

Yes

enabled

WDY_BOOLEAN

true

Yes

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

wrapping

WDY_BOOLEAN

true

Yes

 

Aggregations in the View Designer

Name

Cardinality

Type

Toolbar Element

0..n

ToolBarItem

Toolbar Popin

0..1

Popin

right justified. Toolbar

0..n

ToolBarItem

Note

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

        UIElement

        ContextMenuProvider

        ViewElement

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

accessibilityDescription

ACCESSIBILITY_DESCR

WDY_MD_TRANSLATABLE_TEXT

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_TOOLBAR=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_TOOLBAR=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_TOOLBAR=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

design

DESIGN

WDUI_TOOLBAR_DESIGN

design: emphasized

CL_WD_TOOLBAR=>E_DESIGN-EMPHASIZED

design: standard

CL_WD_TOOLBAR=>E_DESIGN-STANDARD

design: transparent

CL_WD_TOOLBAR=>E_DESIGN-TRANSPARENT

enabled

ENABLED

WDY_BOOLEAN

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_TOOLBAR=>E_VISIBLE-NONE

visible: visible

CL_WD_TOOLBAR=>E_VISIBLE-VISIBLE

wrapping

WRAPPING

WDY_BOOLEAN

 

Dynamic Programming of Aggregations

View Designer Name

Runtime Name

Cardinality

Toolbar Element

TOOLBAR_ITEMS

0..n

Toolbar Popin

TOOLBAR_POPIN

0..1

right justified. Toolbar

TOOLBAR_RIGHT_ITEMS

0..n

 

Example

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

 

End of Content Area