EditBox Properties

Properties of a region of text.

An EditBox can be used to display and edit text, numeric, or time-related types of data on the application screen. The EditBox control is supported for these platforms:

General

Property Description
Label
  • Label – text identifying the control on the user interface.
  • Label position – position of the label in relation to the control it describes.
Input data binding
  • Key – unique identifier within the current scope, used when setting or retrieving a value. Click New key to create a new key for the control.
    Note: If the value is not unique, the Problems view reports a missing key error.
  • Default value – default value for the control.
Read only Specifies that the control is read-only. Default: unselected.
Note: The read-only property is not supported on the Windows Mobile platform for the Checkbox, Slider, and Choice controls.
Password If selected (set to true), text entered in the EditBox is replaced with asterisks. The default is false.
Locale specific This option is enabled only with DATE, DATETIME, and TIME logical types. If selected, the content of the cell is rendered in Locale Display format.
Allows null Determines whether the generated HTML definition of the control identifies the field as supporting NULL:
  • If selected, enables application users to change the field value between NULL and non-NULL and save it.
  • If not selected, prevents users from modifying the value datatype.
Note: The Allows null property is supported only in the jQueryMobile look and feel. It is not supported for Windows Mobile devices.
Logical type Select the logical type for the EditBox:
  • TEXT – string data
  • NUMERIC – numeric data
  • DATE – absolute values or values relative to the current day using simple calculations in days, for example, “2008-05-24” "today" "today+1" "today-1." All values are expected to be in UTC.
  • DATETIME – absolute values or values relative to the current time or day using simple calculations in seconds, for example, "2008-05-24" or "2008-05-24T14:30:15" "today" "today+86400" or "today-86400." In "today+nnn," the nnn means seconds and "today" is interpreted as the current date time, 12:00PM.
    Note: Null values in the DateTime type are not supported for BlackBerry 5 devices.
  • TIME – only absolute values, for example, "14:30" or "14:30:15." Valid values are 00:00:00 to 23.59:59.
Note: Available properties vary for each logical type. For example, some properties might apply only to the numeric type, and some apply only to the text type.
Input type Specifies the type attribute of an HTML5 input element to add one of these labeled input boxes to a jQuery Mobile-style form:
  • OTHER
  • EMAIL
  • NUMBER
  • SEARCH
    Note: The search box is not supported for BlackBerry 5 devices.
  • TEL (Telephone)
  • URL

Advanced

Property Description
Content size
  • Maximum length – maximum number of characters allowed for the control.
  • Number of lines – number of lines for the control.
  • Number of decimals – number of digits after the decimal point—valid range is 0 – 28. Valid only for numeric attributes. The default is zero.
Validation
  • Minimum value – smallest allowed value for numeric input. Valid only in with numeric attributes.
  • Maximum value – largest allowed value for numeric input. Valid only with numeric attributes.
  • Required – specifies that user input is required.
  • Validation regular expression – if the user enters text in the control, the input has to comply with the provided regular expression.
  • Validation message – the error message displayed to the user if the input validation criteria do not match.
Time precision Specifies the precision of the time portion displayed to the user and calculations.
Note: This property is used only if the EditBox logical type is datetime or time.
Credential cache username If the widget supports cached credentials, select to specify that the EditBox be treated as a user name.
Credential cache password If the widget supports cached credentials, select to specify that the EditBox be treated as a password.
Parent topic: Hybrid App Controls