ui.Form.setElementComment

Set the comment/hint of form elements.

Syntax

setElementComment(
   name STRING,
   comment STRING )
  1. name defines the name of the node, see Identifying elements in ui.Form methods.
  2. comment the text of the element comment.

Usage

Change the comment attribute of a form element with the setElementComment() method.

The comment is used to display a hint text, for example with a tooltip when mouse hovers a toolbar item.

Pass the identifier of the form element. The identifier is the element name as defined in the form definition.
Note: All elements with this name will be affected. If you want to distinguish all form elements, use unique names in the form definition file.