Skip to main content

field

Last updated 9/12/2025

The

field
property allows you to access a field on the current form and returns the value associated to the
fieldID
in the format of
five.field.<fieldID>

When using the

field
property on a form field or a screen field, it will be applied to the specific
fieldID
and you can read or write a value.

When using the

field
property on a data field (data views), any field in the row can be accessed and the value can be read.

Functions using

five.field.<fieldID>
can be attached to the following event and display fields:

Forms
  • On Selection
  • On Show
  • On Add
  • On Edit
  • On Cancel
  • On Sub Form Complete
  • On Complete
  • On Finish
Form Pages
  • On Selecting
  • On Selected
  • On Leaving
Form Fields and Screen FieldsData FieldsDisplay Form Fields

What five.field.<fieldID> Represents

five.field
contains all the fields on the current form.

fieldID
is the field ID of an actual field on that form - for example:

  • Quantity
  • Price
  • Fees
  • Total
  • StockKey

So when you write

five.field.Quantity
you are accessing the value of the field
Quantity
on the current form.

How it Works

Reading a value:

Gets the current value stored in the Quantity field
const quantity = five.field.Quantity

Writing a value:

Updates the Total field on the form
five.field.Total = five.field.Quantity * five.field.Price

Examples

field