ScriptNumericUpDown

From Q
Jump to: navigation, search

This feature is new in Q 4.8.

ScriptNumericUpDown

Represents a number-entry box into that also has up and down arrow buttons. The control is created by the RuleForm object's newNumericUpDown() function. Use setMinimum() and setMaximum() to change the constraints for number entry. Use setIncrement() to control the change triggered by the up and down arrow buttons.

getValue()

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.

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 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.

setDefault(value)

Sets the default value.
valueA number.

setIncrement(value)

Sets the amount by which the number is raised or lowered when the up and down arrow buttons are pressed. The default is 1.
valueA number.

setMaximum(value)

Sets the maximum value for this number. The default is 100.
valueA number.

setMinimum(value)

Sets the minimum value for this number. The default is 0.
valueA number.

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