Show TOC

 ScrollContainerLocate this document in the navigation structure

Definition

The ScrollContainer UI element enables you to use a vertical and horizontal scroll bar for the visible UI elements Group and Tray.

Description of UI Element Properties
  • accessibilityDescription

    When accessibility is activated, the assigned text is added to the tool tip. This description provides semantic details of the UI element and is only read by the screen reader if the user focuses the complete Ul element.

  • defaultButtonId

    Specifies the ID of the assigned default button.

  • enabled

    The enabled property has no effect on the UI element children you inserted into the UI element container. If, for example, you set the enabled property to false in the group UI element, an input field inserted in it is not automatically deactivated. If the UI element children in this group UI element are also to be deactivated, you must set the relevant property for each UI element separately.

  • handleHotkeys

    Specifies whether this ScrollContainer acts as a separate container for hotkeys. If this property is set to true then all hot keys defined by UI elements within this ScrollContainer will be handled by this ScrollContainer. This defines a new scope for hot keys. More information: Implementing Hot Keys

  • height

    Determines the height of the ScrollContainer, which you can specify in relative CSS units like em or ex.

  • scrollingMode

    Specifies how the scroll bar appears within the UI element container. The scrollingMode property can be filled with the following values and is represented by the enumeration type WDScrollingMode.

    auto

    The scroll bar within the container is activated automatically.

    both

    A vertical and horizontal scroll bar are activated.

    none

    Scrolling within the text context is not possible.

  • width

    Determines the width of the ScrollContainer. You can specify this in CSS sizes, such as em, ex, pixels or percentage values.

    Note

    The properties enabled and tooltip are ignored and do not affect the browser.

    Caution

    The properties height and width must be specified for the ScrollContainer UI element - that is, you must assign values to these properties for the scrolling modes both and auto. If you do not want to have scroll bars for the UI element and assign the value none to the scrollingMode property, you should use another container UI element - for example, the TransparentContainerUI element.

Properties Overview
Name Interface Type Initial Value Bindable

accessibilityDescription

IWDScrollContainer

String

 

bindable

defaultButtonId

IWDScrollContainer

String

 

bindable

enabled

IWDUIElement

boolean

true

bindable

handleHotkeys

IWDScrollContainer

boolean

false

not bindable

height

IWDUIElementContainer

String (CSS size)

 

bindable

scrollingMode

IWDScrollContainer

WDScrollingMode

none

bindable

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDUIElementContainer

String (CSS size)

 

bindable