Subtitle

Display of additional text below the heading in a control element.

The subtitle is displayed within the graphical representation of the control below the heading if this is displayed, otherwise instead of the heading. The text can be defined as a constant in the control element or obtained from the language switch from EASY UI Designer.

The subtitle is displayed in a subtitle display ("Subtitle" element).

The "Subtitle" element, for example, is contained in the "Group" control element.

The source, layout, display, paragraph and font of the subtitle can be configured via the properties of the "Subtitle" category of the control element, the colours of the subtitle via the properties of the "Colors" category.

The subtitle is not displayed by default. If you want to display the subtitle in the control element, activate the "ShowSubtitle" property.

The following properties define the subtitle text or the source of the subtitle text:

SubtitleText

Use this property if the subtitle text is language-independent, e.g. a name or a short description.

LocalisableSubtitleText

If the subtitle text is to be language-dependent, the text selection dialogue can be opened here via the button. This establishes the connection to an EASY UI Designer text definition. The property then saves the full name of the text definition.

The "LocalisableSubtitleText" property has priority over the "SubtitleText" property.

The layout of the subtitle display can be configured using the following properties:

SubtitleHeight

Defines the height of the subtitle display.

SubtitleMargin

Defines the outer spacing of the subtitle display, i.e. between the edge of the subtitle display and its parent or neighbouring element.

SubtitlePadding

Defines the internal spacing of the subtitle display, i.e. between the edge of the subtitle display and its content, i.e. the actual subtitle text.

SubtitleWidth

Defines the widthof the subtitle display.

The following properties are available for displaying the subtitle:

ShowSubtitle

Determines whether the subtitle should be displayed.

Line breaks, line height and text alignment of the subtitle are configured using the following properties:

SubtitleLineClamp

Specifies the number of lines for the subtitle if the subtitle text is longer than the subtitle display width (SubtitleWidth). The property only has an effect if the "SubtitleTextWrapping" property is set to "WrapWithLineClamp". Line breaks are inserted instead of spaces in the subtitle text, i.e. there is no wrapping within a word.

SubtitleLineHeight

Defines the height of the text line(s). See also CSS reference: line-height

SubtitleTextAlignment

Defines the horizontal alignment of the subtitle text within the subtitle display. See also CSS reference: text-align

SubtitleTextTrimming

Determines how the subtitle text is shortened if it is longer than the width of the subtitle display.

Clip
The excess text is cut off.
Ellipsis
The excess text is abbreviated by an ellipsis (...) (default setting).
Overflow
The text is displayed and may extend beyond the edge of the control element.

SubtitleTextWrapping

Determines whether and how the subtitle text is wrapped.

NoWrap

No line break, the subtitle text is displayed in one line. If the subtitle text is longer than the width of the control element, the excess text is either truncated, abbreviated by an ellipsis or protrudes beyond the edge of the control element, depending on the setting in the "SubtitleTextTrimming" property.
Wrap

If the subtitle text is longer than the width of the control element, the text is displayed in multiple lines. Line breaks are automatically inserted at the end of each line after a space or a hyphen.
- If the width of the control element ("Width" property) is set to "auto", the width of the control element adapts to the text length until its width is limited by the width of the parent container.
- If the height of the control element is smaller than the total height of the rows, rows may protrude beyond the lower limit of the control element. Cutting off the rows is prevented in the RadioButtonGroup control element by the "Height" property being set to "auto" by default. In the Group, however, the width is set to 200 px by default. If necessary, manually set the "Height" property in the Group to "auto".
WrapWithLineClamp

If the text is longer than the width of the control element, the text is displayed in multiple lines. The text will contain a maximum of as many lines as specified in "SubtitleLineClamp". Line breaks are automatically inserted at the end of each line after a space or a hyphen. If there is excess text, an ellipsis is automatically inserted at the end of the last line. The ellipsis is inserted regardless of the setting in "SubtitleTextTrimming".
- The notes for "Wrap" apply accordingly to "WrapWithLineClamp".
WrapWithWordBreak

If the text is longer than the width of the control element, the text is displayed in multiple lines. With this setting, text wrapping is also permitted within the words.
- The notes for "Wrap" apply accordingly to "WrapWithWordBreak".

The font of the subtitle text is configured using the following properties:

SubtitleFontClass

Defines the font class of the subtitle text.

The property contains a list of font classes from which one can be selected. The settings are obtained from a CSS file (fontclasses.css), which can be found in the resourcesWtypography folder in the client project directory.

SubtitleFontSize

Defines the font size of the subtitle text. See also CSS reference: font-size

SubtitleFontWeight

Determines how thick or thin the letters of the subtitle text should be displayed. See also CSS reference: font-weight

SubtitleTextContrast

Determines how light the subtitle text should be displayed, from 1 (opaque, default setting) to 0.5 (semi-transparent) to 0 (completely transparent). See also CSS reference: opacity

SubtitleUppercase

Specifies that the subtitle text is displayed in capital letters. See also CSS reference: text-transform