Entering content frame

Background documentation Explanation Locate the document in its SAP Library structure

The UI element explanation is used to display help texts for an application. The help text is created at design time by the information developer or technical editor.

Note

In the design time the tooltip is not checked to ensure Accessibility, since there is no use for a tooltip with this UI element.

Examples of the Display: Explanation for an InputField

This graphic is explained in the accompanying text

This graphic is explained in the accompanying text

The behavior varies depending on the help mode.

·        Help mode = on

The UI element explanation contains a text that appears on the screen permanently and should contain explanations about the screen or parts of the screen.

If the explanation property is set for another UI element (for example, for a Button), this UI element is provided with a symbol on the screen (information indicator, i). If the cursor is moved over this symbol, the content of this property, a quick info, is displayed. In this case the property actually contains an F1 help.

Caution

The content of the tooltip property is read in accessibility mode only by the screen reader.

·        Help mode = off

The UI element Explanation and all information indicators are not displayed, that is there is no primary help available.

Note

You can activate the help mode either in the personal settings in the portal or in the associated URL Parameters.

 

Runtime Class

CL_WD_EXPLANATION

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

No

enabled

WDY_BOOLEAN

true

Yes

text

Text

 

No

tooltip

Text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

Note

Further properties that can be inherited are defined in the associated higher-level class.  The associated interface elements are:

·         UIElement

·         ViewElement

Dynamic Programming

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

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

enabled

ENABLED

WDY_BOOLEAN

text

TEXT

WDY_MD_TRANSLATABLE_TEXT

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 application, WDR_TEST_UI_ELEMENTS.

 

 

Leaving content frame