Show TOC

SectionHeader PropertiesLocate this document in the navigation structure

Expand the properties to display further details.

id

The ID is a unique identification.

contextMenuBehaviour

Assignment of the context menu Note that the context menu can be overwritten in the hook method WDDOONCONTEXTMENU in all cases.

Value

Description

inherit

The UI element inherits the static context menu from its parent UI elements.

provide

The UI element context menu is the one which was specified by the contextMenuID.

suppress

No static context menu is created.

design

Display format of the SectionHeader

Value Example of the Visual Display Description

standard

Highlighted standard display

underline

Highlighted, underscored display

enabled

Specifies whether or not an event can be triggered by a user interaction. If the value is TRUE, the view elements positioned above it are used at runtime to determine the value. This means that if the surrounding container is not enabled, all the containers within this are also not enabled.

isDragHandle

Defines a SectionHeader as a drag handle, which is used to rearrange different screen areas for Drag&Drop, that is, the SectionHeader can be moved.

level

Level of the section in the document context. The level depends on the embedding of the SectionHeader within the context of the document.

Value Description

header4

header4 should be used at the top level. To divide the form up further, SectionHeader with level=header5 can be used.

header5

header5 should be used at the second highest level. To divide the form up further, SectionHeader with level=header6 can be used.

header6

Used for lowest level headings in forms.

styleClassName

With this property you can create your own style definitions to change the appearance of UI elements (for example, the font color of buttons). With interface IF_WD_CUSTOM_STYLE_MANAGER (method CREATE_CUSTOM_STYLE) you can create your own style classes. You define the various style definitions for a style class within objects of interface type IF_WD_CUSTOM_STYLE in the form of a name/value list. You can then assign these style definitions to specific UI elements. The value of parameter STYLE_CLASS_NAME of method CREATE_CUSTOM_STYLE must be the same as the value of property styleClassName of the UI element. This property can be personalized by administrators.

Note

This feature is only available in HTML standards mode. For more information, see UI Control Rendering in Standards Mode, and 1753544 Information published on SAP site.

Note that setting a style is not always visible. Other properties can dominate and overwrite these. This can have an impact on the present style or on changes made in the future.

Example
A style definition is created and added to the application in the following example. The style definition ensures that the text for buttons that use this style definition is displayed in red:
data l_style_manager  type ref to if_wd_custom_style_manager.
data l_style          type ref to if_wd_custom_style.

" Get the custom style manager
l_style_manager =
  wd_comp_controller->wd_get_api( )->get_application( )->get_custom_style_manager( ).

" Create a new custom style with name myButtonStyle for BUTTON elements
l_style =
  l_style_manager->create_custom_style( style_class_name = `myButtonStyle`
                                           element_type     = 'BUTTON' ).
" Set font color to red
l_style->add_style_property( name  = `fontColor`
                               value = `red` ).
" Add custom style
l_style_manager->add_custom_style( l_style ).

To assign the style definition to a button, set the button property styleClassName to the value myButtonStyle.

You can find an application example in the system in component WDR_TEST_CUSTOM_STYLES.

For more information, see the system documentation for the following interfaces:
  • IF_WD_CUSTOM_STYLE
  • IF_WD_CUSTOM_STYLE_MANAGER
text

Header text
Primary Property 
This property can be personalized by an administrator.

textDirection

Text or writing direction. This enables labels of interface elements to be read in languages that have an RTL writing direction, such as Arabic or Hebrew, as opposed to LTR for languages like English. This property can be personalized by administrators.

Value Description Can be Set Using Personalization

inherit

The text direction is inherited from the parent element. Therefore, the text direction is identical to that of the parent element.

yes

ltr

Left to right text direction

yes

rtl

Right to left text direction

yes

tooltip

Quick info text that appears when the user moves the mouse pointer over the UI element. If Screen Reader is supported, extra text is added automatically to the tooltip in order to support accessibility. Be aware of the following if a hot key is set for one of the following UI elements: AbstractButton and those UI elements that inherit from this: IconButton, LinkToAction, LinkToUrl, MenuActionItem, ToolBarLinkToAction, ToolBarLinkToUrl: The relevant key combination for the corresponding hotkey is always automatically inserted into the tooltip of the appropriate UI element. If a text already exists for the tooltip, the text for the hotkey is appended to the end. This property can be personalized by administrators. See also 1974590.

visible

Visibility of the interface element. Both users and administrators can personalize this property.

Values Description Can be Set Using Personalization

NONE

The UI element is not visible on the screen and takes up no space.

Yes

VISIBLE

The UI element is displayed on the screen.

No