Integer Component

On This Page

Function

a!integerField( label, instructions, required, readOnly, disabled, value, validations, saveInto, validationGroup, requiredMessage, align, labelPosition, refreshAfter, placeholder, helpTooltip, masked, accessibilityText, showWhen, marginAbove, marginBelow )

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, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, `“validation group”` is not a valid value. You need to add an underscore between words: `“validation_group”`. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'
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 saveInto expression is evaluated. Valid values: `"UNFOCUS"` (default), `"KEYPRESS"`. When set to `"UNFOCUS"`, the expression evaluates when the user deselects the field after changing its value. When set to `"KEYPRESS"`, the expression evaluates after every character typed into the field.
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.
Show When	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.
Margin Above	marginAbove	Text	Determines how much space is added above the component. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD" , "MORE", "EVEN_MORE".
Margin Below	marginBelow	Text	Determines how much space is added below the component. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".

Usage considerations

Displaying values

If you want to display a number with thousand separator, 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.

Examples

Use the interactive editor below to test out the example code.

Collect an integer value from a user

a!localVariables(
  local!referenceNumber: 0,
  a!integerField(
    label: "Reference Number",
    value: local!referenceNumber,
    saveInto: local!referenceNumber
  )
)

Integer with only a label

a!integerField(
  label: "Reference Number",
  value: 12345,
  readOnly: true
)

Integer with a validation

a!localVariables(
  local!storedValue: tointeger(null),
  a!integerField(
    label: "Number of Items",
    value: local!storedValue,
    saveInto: local!storedValue,
    validations: if(
      local!storedValue < 1,
      "You must enter at least one item",
      ""
    )
  )
)

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Interfaces	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling	Incompatible	Cannot be used in autoscaled processes.
Event Consumer Filter Conditions	Compatible	Can be used in filter conditions.
Event Consumer Event Handlers	Compatible	Can be used in event handler expressions.

The following recipes include usage of the Integer Component.

Expand/Collapse Rows in a Tree Grid (Hierarchical Data, Grids):
Create a grid that shows hierarchical data and allows users to dynamically expand and collapse rows within the grid.
Use Selection For Bulk Actions in an Inline Editable Grid (Grids):
Allow the user to edit data inline in a grid one field at a time, or in bulk using selection.

Feedback

Was this page helpful?