To configure the help text for the form items, perform the following steps:
- Create a form using Canvas Studio Form Designer. Refer the Form Framework section in this document for more information on creating a form.
- Select the help indicator property for the form item for which you want to display the help text. For example, in the following screen shot, help indicator has been enabled for the TENOR field present in the DEPOSIT_STAT_FORM
- Selecting the help indicator property is mandatory if you want to display help text for the form item in your end application. The help text as such cannot be provided in Form Designer. You must configure the help text for the form item ID in the properties file for it to display in your end application.
- Help indicator property is applicable only for selective form items as indicated in the table above.
3. In the properties file (for example, common_en_US.properties) provide the help text for the form item as raw-key value pair as follows:
- <Form Item ID>_HELP_MSG = <help text>
For example,
TENOR_HELP_MSG = The length of time until a loan is due.
The help text will be applied to the form item ID (for example, TENOR) wherever it is used in the application.
You have the option to display the help text either inline or at the bottom of the form item. The default option is 'inline'. That is, the help text displays when the user hovers over the help icon.
- To display the help text inline for the form items, provide the following code in any JavaScript listener file:
canvas.env.options.form.helpLblPosition='inline'; // Note that this code will reflect globally for all form items at the application level.
Sample screen shot of the form item with the help text:
