form

Last updated 18/12/2025

The

form

property allows you to access a field on a form in the form stack and returns the value associated to the

fieldID

in the format of

five.form.<actionID>.<fieldID>

When using the

form

property on a form field, it will be applied to the specific form's

actionID

and the

fieldID

on the form, you can read or write a value.

The

form

property only applies to the form stack, drill downs are not included, the

stack

property needs to be used for a drill down.

Functions using

five.form.<actionID>.<fieldID>

can be attached to the following event fields:

Form Fields

• On Enter
• On Click
• On List Select
• On Validate
• On Exit

What five.form.<actionID>.<fieldID> Represents

five.form

contains all the fields on the current form and sub-forms in the form stack.

actionID

is the action ID of the form in the stack - for example:

• Sells
• Buys

fieldID

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

• Quantity
• Price
• Fees
• Total
• StockKey

So when you write

five.form.Sells.Quantity

you are accessing the value of the field

Quantity

on the

Sells

form in the form stack.

How it Works

Reading a value:

Gets the current value stored in the Quantity field

const quantity = five.form.Sells.Quantity

Working With Query Parameters

The

form

property can be used as a parameter in your queries, this needs to be defined on the Parameters page on the Queries form in the following format:

{{five.form.Sells.SellKey}}

Examples

form