Helper text

Display of a text as a help or hint for the correct input.

The help text is displayed below the input field of an input control. The text can be defined as a constant in the control or obtained from the language switch from »EASY UI Designer«.

The help text is displayed in a help text display ("HelperText" element).

The "HelperText" element is contained in the "NumericVarIn" control element, for example.

The source, layout, display, paragraph and font of the help text can be configured via the properties of the "HelperText" category of the control, the colours of the help text via the properties of the "Colors" category.

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

The following properties define the text itself or the text source:

HelperText

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

LocalisableHelperText

If the 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 "LocalisableHelperText" property has priority over the "HelperText" property.

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

HelperTextHeight

Defines the height of the help text display.

HelperTextMargin

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

HelperTextWidth

Defines the widthof the help text display.

The following properties are available for displaying the help text:

ShowHelperText

Determines whether the help text should be displayed.

The text alignment and line height of the help text display are configured using the following properties:

HelperTextAlignment

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

HelperTextLineHeight

Defines the height of the text line of the help text display. See also CSS reference: line-height

The help text is displayed on a single line. Excess text is abbreviated by an ellipsis.

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

HelperTextContrast

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

HelperTextFontClass

Defines the font class of the help 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.

HelperTextFontSize

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

HelperTextFontWeight

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