FormControl.helpText Method
Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.
Syntax
public str helpText([str value])
Run On
Client
Parameters
- value
Type: str
The value to assign as the Help text for the control.
Return Value
Type: str
The string that should be displayed at the bottom of the screen.
Remarks
Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.
Examples
The following example shows how to set and return the Help text for a control.
// objCtrl previously assigned to a control
// Retrieve existing help text.
print objCtrl.helpText();
// Specify new help text.
objCtrl.helpText("My new help text");