Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:


 

Description

The Numeric Text Field is similar to the standard Text Field, except that it is specialized for use with numbers. Instead of a "text" property, it has four numeric "value" properties. Which one you use depends on the mode of the text box.

Like the standard Text Field, this text field can operate in protected mode. When you enable the protected property, the field is not editable even when it receives input focus. The user must double click on the field or press enter in order to edit the field. When they are done (press enter again or leave the field), the field becomes non-editable again.

The Numeric Text Field also supports the reject updates during edit feature. This feature ignores updates coming from property bindings while the component is being edited by a user.

Properties
NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
BackgroundThe background color of the text box (when editable).Color.editableBackgroundAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
Commit On Focus LossIf true, any pending edit will take effect when focus is lost. If false, the user must press ENTER for an edit to take effect.boolean.commitOnFocusLostBehavior
CursorThe mouse cursor to use when hovering over this component.int.cursorCodeCommon
Data QualityThe data quality code for any tag bindings on this component.int.dataQualityData
Decimal FormatThe formatting string used for displaying numbers.String.decimalFormatAppearance
Defer UpdatesWhen true, the value properties will not fire updates while typing, it will wait for Enter to be pressed.boolean.deferUpdatesBehavior
Editable?If true, this is an input box, if false, this is display-only.boolean.editableBehavior
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
Error on Out-of-BoundsShow an error message if the user input is out-of-bounds?boolean.errorOnOutOfBoundsBehavior
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
Horizontal AlignmentDetermines the alignment of the label's contents along the X axis.int.horizontalAlignmentLayout
MaximumThe maximum value (inclusive), if useBounds is true.double.maximumData
MinimumThe minimum value (inclusive), if useBounds is true.double.minimumData
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Non-Editable BackgroundThe background color to use when this text box is non-editableColor.nonEditableBackgroundAppearance
Number TypeWhat type of numbers should this field accept?int.modeData
Out Of Bounds MessageThe error message to display if input is out-of-bounds.String.outOfBoundsMessageBehavior
Protected Mode?If true, users will need to double-click in the field in order to edit the value.boolean.protectedModeBehavior
Reject Updates During EditIf true, this field will not accept updates from external sources (like DB bindings)<BR>while the user is editing the field.boolean.rejectUpdatesDuringEditBehavior
StylesContains the component's styles.Dataset.stylesAppearance
SuffixA string to display after the value.String.suffixAppearance
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
Use Bounds?Only allows user-entered values between a minimum and maximum. Unless you turn on "Error on out-of-bounds", user-entered values will be silently modified to be in-bounds.boolean.useBoundsBehavior
Value (Double)The value as a double. Make sure you use the value property that corresponds to your Number Type setting.double.doubleValueData
Value (Float)The value as a float. Make sure you use the value property that corresponds to your Number Type setting.float.floatValueData
Value (Integer)The value as an integer. Make sure you use the value property that corresponds to your Number Type setting.int.intValueData
Value (Long)The value as a long. Make sure you use the value property that corresponds to your Number Type setting.long.longValueData
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Scripting
Scripting Functions
 getSelectedText()
  •  Description

Returns the currently selected or highlighted text in the text field.

  • Parameters

Nothing

  • Return

String - Returns the currently selected or highlighted text in the text field.

  • Scope

Client

Extension Functions

This component does not have extension functions associated with it.

Event Handlers
 focus
 focusGained

This event occurs when a component that can receive input, such as a text box, receives the input focus. This usually occurs when a user clicks on the component or tabs over to it.

.source

The component that fired this event.       

.oppositeComponent

The other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       

 focusLost

This event occurs when a component that had the input focus lost it to another component.

.sourceThe component that fired this event
.oppositeComponentThe other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       
 key
 keyPressed

An integer that indicates whether the state was changed to "Selected" (on) or "Deselected" (off). Compare this to the event object's constants to determine what the new state is.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyReleased

Fires when a key is released and the source component has the input focus. Works for all characters, including non-printable ones, such as SHIFT and F3.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyTyped

Fires when a key is pressed and then released when source component has the input focus. Only works for characters that can be printed on the screen.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION  constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseEntered

This event fires when the mouse enters the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseExited

  This event fires when the mouse leaves the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mousePressed

  This event fires when a mouse button is pressed down on the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

 

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.  
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed.
.propertyName

The name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.       

Examples
Code Snippet
#The following script can be executed on a mouse released event handler.
#This would write the selected text to a custom property called highlightedText.

event.source.highlightedText = event.source.getSelectedText()
2-digit Numeric Format

Property NameValue
BorderField Border
Number TypeFloat
FontDialog, BoldItalic, 15
Decimal Format#,##0.00
  • No labels