ScriptTextBox

This feature is new in Q 4.8.

ScriptTextBox

Represents a text box into which users may only enter anything. The control is created by the RuleForm object's newTextBox() function.

controlName

Unique name for each control. Used as key for storing serialized values. May be null if the control will never store values (e.g. ScriptLabel).

form

The format whose script created this control. The format stores our value (serialized to a string).

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.

Example:

c.lineBreakAfter = true;

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.

value

A string.

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