Show TOC

CaptionLocate this document in the navigation 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. 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.

imageHeight

Specifies the height of the Caption's icon. You can specify the height in CSS units like em, ex, pixels, or percentage.

imageSource

Defines the path to the image source. More information: Specifying the Image Source

imageWidth

Specifies the height of the Caption's icon. You can specify the height in CSS units like em, ex, pixels, or percentage.

isDragHandle

Determines if this caption can be used as a drag handle for runtime authoring. The innermost surrounding layout cell that is enabled to act as a drag source can then be grabbed by this handle. More information: Implementing Drag and Drop

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 .