Show TOC Start of Content Area

Object documentationCaption This graphic is explained in the accompanying text  Locate the document in its SAP Library structure

Definition

The Caption class, which implements the IWDCaption interface, is a concrete subclass of the IWDAbstractCaption class. The UI element can be used by several UI elements – such as Group, Tab, Table, TableColumn, and Tray – to provide a header or an icon for them.

Note

The enabled property which is inherited by the superclass UIElement, does not affect the display.

Description of UI Element Properties

      imageAlt

This property is deprecated. Use tooltip instead.

      imageFirst

Defines the position of the icon in relation to the corresponding text. If the value of this property is true, the icon is displayed to the left of the text.

      imageSource

defines the path to the image source.

More inforamtion: Specifying the Image Source

      readOnly

Specifies whether or not the user can check the checkbox.

      state

Describes the error status of the UI element. The data type of this property corresponds to the enumeration type WDState. You can use the following values in the application:

normal

Describes the default state of the UI element.

required

Specifies whether the entered value is required.

      text

Specifies the text.

      textDirection

Specifies the text direction and allows you to use subordinated UI elements for texts in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.

inherit

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

ltr

The text runs from left to right.

rtl

The text runs from right to left.

The default value for this property is inherit.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

enabled

IWDUIElement

boolean

true

bindable

imageFirst

IWDAbstractCaption

boolean

true

bindable

imageSource

IWDAbstractCaption

String

 

bindable

textDirection

IWDAbstractCaption

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

 

End of Content Area