ScriptLabelledTextBox
Represents a text box into which users may enter anything. The control is created by the
RuleForm object's textBox() function.
getNumberValue()
Retrieves the number entered.
| Returns: | The number entered, or (if set) the default. If no default has been provided and nothing has been entered then this will return null. |
getValue()
Retrieves the text entered.
| Returns: | The text entered, or (if set) the default. If no default has been provided and nothing has been entered then this will return an empty string. |
isExpression
Use this to control whether the item should be treated as an expression or as a string in R code. Only applicable to textBox, comboBox and dropBox controls.
lineBreakAfter
Use this where your Rule has many controls, and they do not fit comfortably in a single line. It allows you to specify that a new row will be started after this control.
requireNumberValue()
Retrieves the number entered. If no number has been entered and no default has been set then the script will end immediately and this control will be marked invalid.
| Returns: | The number entered, or the default if nothing has been entered. |
requireValue()
Retrieves the text entered.
| Returns: | The text entered, or (if set) the default. If no default has been provided and nothing has been entered then this will return an empty string. |
setDefault(value)
Sets the default text to appear in this box.
type
Returns the name we use to refer to this class in the documentation.
visible
Set this to false if you want a control you have created to not be shown to the user. This property is only available in Q v5.4