Show TOC

Explanation PropertyLocate this document in the navigation structure

Use

You can also set the UI element Explanation for different UI elements. This property is then displayed, depending on whether the help mode is on or off.The behavior varies according to the help mode:

  • Help mode = on

    If the explanation property is set for a particular UI element, this UI element is underlined in green on the screen. If the cursor is moved over this symbol, the content of this property is displayed. This is in addition to, and independent of, any available tooltip. In this case the property actually contains an F1 help.

    Explanation Property plus Tooltip for Delivery Time

    Note

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

  • Help mode = off

    The content of the explanation is not displayed. No primary help is available.

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

In the view designer you can create the text for the property explanation in the input field for the value of this property. The text can either be entered manually (a maximum of 255 characters) or it can be an OTR alias text, for which you use the notation $OTR:Aliasname . You can also use F4 help to specify whether for this field you want to display data element documentation or a part of it as help text on the screen. This would be the data element documentation for the data element, to which you bound the primary property of the property in question. You can choose the following display variants for the data element documentation:

  • Short text from the ABAP Dictionary

  • Keyblock &DEFINITION& from the data element long text

  • Keyblock & USE & from the data element long text

  • Link to full data element documentation (long text)

The help text is displayed on the screen when the mouse pointer is moved over the respective UI element.

The various help options can be specified as follows:

Selecting Help Options in the View Designer

To display data element documentation there must be a Primary Property for the UI element, and you must have bound a data element to the data element documentation from the ABAP Dictionary. If there is no such data element, the options for the data element documentation are grayed out on the selection popup. This way of displaying data element documentation is not possible for Button s because they have no primary property.

Example

Example of the different ways of displaying parts of the data element documentation:

Delivery Time

From the data element WDR_TEST_HELP_DELIVERY_TIME the definition text is used on the left and the usage text on the right.

You can set the explanation property for the following UI elements:

Deactivating F1 Help

By default the data element documentation, if available, is displayed when the help mode is activated. You can however deactivate the display of data element documentation and define exceptions for individual fields. The application parameter WDHIDEMOREFIELDHELPASDEFAULT is provided for this purpose.

If this parameter is set to X and the toggle Display Note on Full Data Element Documentation is activated in addition to the options with Help Text for Mouse-Over and From the Data Eelement for the property explanation of a specific field, the text Right Mouse Button for More is displayed in brackets after the information text. Using the right mouse button and More Field Help the relevant data element documentation is displayed.