Entering content frame

Background documentation Caption Locate the document in its SAP Library structure

The UI element Caption is used by a row of UI elements, for example, Group, Tab, Table, TableColumn and Tray, to provide a heading or a title.

Note

If the property text has not been set, the property tooltip is checked during the design time to ensure Accessibility.

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.

Examples of the Display

This graphic is explained in the accompanying text

This graphic is explained in the accompanying text

 

Runtime Class

CL_WD_CAPTION

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

no

enabled

WDY_BOOLEAN

true

yes

imageAlt

Text

 

yes

imageFirst

WDY_BOOLEAN

true

yes

imageSource

STRING

 

yes

text

Text

 

yes

textDirection

WDUI_TEXT_DIRECTION

inherit

yes

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:

·         AbstractCaption

·         UIElement

·         ViewElement

Dynamic Programming

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

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

enabled

ENABLED

WDY_BOOLEAN

imageFirst

IMAGE_FIRST

WDY_BOOLEAN

imageSource

IMAGE_SOURCE

STRING

text

TEXT

WDY_MD_TRANSLATABLE_TEXT

textDirection

TEXT_DIRECTION

WDUI_TEXT_DIRECTION

 textDirection: inherit

CL_WD_CAPTION=>E_TEXT_DIRECTION-INHERIT

 textDirection: ltr

CL_WD_CAPTION=>E_TEXT_DIRECTION-LTR

 textDirection: rtl

CL_WD_CAPTION=>E_TEXT_DIRECTION-RTL

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

 visible: none

CL_WD_CAPTION=>E_VISIBLE-NONE

 visible: visible

CL_WD_CAPTION=>E_VISIBLE-VISIBLE

Example

You can find examples of this interface element in the system in the Web Dynpro application WDR_TEST_UI_ELEMENTS, and in the component WDR_TEST_EVENTS in the view Button.

 

 

 

Leaving content frame