Start of Content Area

Background documentation Explanation  Locate the document in its SAP Library structure

The Explanation UI element is used to display single-line or multi-line help texts for UI element or a Web Dynpro application. The help text is generally edited at design time by the relevant documentation developer or technical editor (but not by the software developer) in the Web Dynpro ABAP authoring environment.

Note

To permit the development of accessible applications, the tooltip property is not checked during design time, since there is no real need for a tooltip with this UI element.

More information:

Help Texts for Web Dynpro Applications

Formats for UI Element Explanation

Example of the Visual Display

This graphic is explained in the accompanying text

 

Runtime Class

CL_WD_EXPLANATION

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

id

STRING

(automatic)

No

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

design

WDUI_EXPLANATION_DESIGN

standard

No

enabled

WDY_BOOLEAN

true

Yes

text

Translatable text

 

No

textDocumentName

DOKU_OBJ

 

No

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

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

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_EXPLANATION=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_EXPLANATION=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_EXPLANATION=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

design

DESIGN

WDUI_EXPLANATION_DESIGN

design: emphasized

CL_WD_EXPLANATION=>E_DESIGN-EMPHASIZED

design: standard

CL_WD_EXPLANATION=>E_DESIGN-STANDARD

enabled

ENABLED

WDY_BOOLEAN

text

TEXT

WDY_MD_TRANSLATABLE_TEXT

textDocumentName

TEXT_DOCUMENT_NAME

DOKU_OBJ

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_EXPLANATION=>E_VISIBLE-NONE

visible: visible

CL_WD_EXPLANATION=>E_VISIBLE-VISIBLE

 

Example

You can find examples in the system in the Web Dynpro applications WDR_TEST_UI_ELEMENTS and WDR_TEST_HELP.

 

 

End of Content Area