Auto Complete

The auto complete field captures a text or a list of texts. It has some “options”, i.e. possible values that are proposed for selection after typing a few characters (at least two). It is also possible to use these options as suggestions only and allow entering new values.

This field is appropriate when there is a long list of options (place names for instance) and for reducing text variations with an open field.

Preview

../../../_images/autocomplete.png

The auto complete field helps with the formatting of open text entries.

Design

Definition

The standard properties apply:

Property

Definition

Type

The type of item (see above).

Name

The name of the item is not visible. It is a “variable” name that will be associated to the data collected. You will refer to this variable name when writing condition and/or validation scripts.

Label

The label is usually a question or a title.

Description

The description gives some guidance about how to enter data, what are their meaning etc.

Required

Whether an input is mandatory.
Note that this does not apply when the visibility Condition is not satisfied.

The following dynamic properties apply:

Property

Definition

Condition

The condition makes an item visible or not, depending of other data. It is a small script which returns a logical value: true when item is visible.
When no condition is specified (which is the default), the item is visible.

Validation

The validation specifies whether the data entry is correct. It is a small script which returns a logical value: true when item value is valid.
Note that this validation script is not evaluated when the visibility Condition is not satisfied.

Validation error message

The validation error message to be displayed when validation fails.

Settings

Property

Definition

Hint

Help text below the input field.

Default

The default value. Only a single value can be specified, even when Multiple choices is set.

Multiple choices

When selected, the captured data is a list of texts. Default is false, i.e. a single value is captured.

Options

The list of predefined values, either to be selected or used as suggestions. For provisioning a lot of options, see How to make a select with a lot of options?

Can enter new value

When selected, an entry that is not in the list of options can be added. Default is false, i.e. a valid entry must be one of the options.

Style

Property

Definition

Label class

CSS class to apply to the field label. See How to style a form item?