Integer Component

Integer

Function: a!integerField()

Displays and allows entry of a single integer number.

When working with a decimal number, use a decimal component. To display a number using a custom format, use a text component.

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Instructions

instructions

Text

Supplemental text about this field.

Required

required

Boolean

Determines if a value is required to submit the form. Default: false.

Read-only

readOnly

Boolean

Determines if the field should display as not editable. Default: false.

Disabled

disabled

Boolean

Determines if the field should display as potentially editable but grayed out. Default: false.

Display Value

value

Number (Integer)

Number to display in the field.

Validations

validations

List of Text String

Validation errors to display below the field when the value is not null.

Save Input To

saveInto

List of Save

One or more variables that are updated with the integer when the user changes it. Use a!save() to save a modified or alternative value to a variable.

Validation Group

validationGroup

Text

When present, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups.

Required Message

requiredMessage

Text

Custom message to display when the field's value is required and not provided.

Alignment

align

Text

Determines alignment of number value. Appian recommends this setting only be used inside the Grid Layout component. Valid values: "LEFT", "CENTER", "RIGHT".

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Refresh After

refreshAfter

Text

Determines when the interface is refreshed with the saved value from the barcode field. Valid values are "KEYPRESS" to refresh after every character typed into the field and "UNFOCUS" (the default value) to refresh when the user deselects the field after changing its value.

Placeholder

placeholder

Text

Text to display in the field when it is empty. Does not show if the field is read only.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Masked

masked

Boolean

Determines if the value is obscured from view. Default: false.

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

  • The integer number is shown with thousand separators when Read-only is true.
  • If you want to display an integer with no thousand separators, or with special formatting such as a currency, use the Text component.
  • Whether placeholder text clears on focus or input varies by device and browser. Placeholder text does not display on Microsoft Internet Explorer 9.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Collect an Integer Value from a User

1
2
3
4
5
=a!integerField(
  label: "Reference Number",
  value: local!referenceNumber,
  saveInto: local!referenceNumber
)

Integer with Only a Label

1
2
3
4
5
=a!integerField(
  label: "Reference Number",
  value: 12345,
  readOnly: true
)

Displays the following:

Integer with a Validation

1
2
3
4
5
6
7
8
9
10
11
12
13
=a!localVariables(
  local!storedValue,
  a!integerField(
    label: "Number of Items",
    value: local!storedValue,
    saveInto: local!storedValue,
    validations: if(
      local!storedValue < 1,
      "You must enter at least one item",
      ""
    )
  )
)

Displays the following:

The following patterns include usage of the Integer Component.

FEEDBACK