Autocomplete controls save time and ensure accuracy by supplying a list of possible values for an input field, based on characters that the user enters.
Unlike a static list, the values presented by an autocomplete control might vary from user to user and from time to time. Depending on the configuration, the control can be activated by entering one or more characters, or no characters, or by clicking the down arrow of the control.
You can display autocomplete controls as combo boxes with the entire autocomplete source list as the drop-down list of the combo box. When users enter text to search and click the down arrow, only the results that match the search criteria are displayed in the list.
Source of autocomplete field values
The list of values in an autocomplete field can be defined in a list bound to a property, or a clipboard page, a data page, or a report definition.
When the source is a clipboard page, data page, or a report definition, you can categorize items within the autocomplete results. When an autocomplete is bound to a data page or report definition that accepts parameters and the parameter value uses a property reference, the list automatically refreshes with new items whenever the property value changes. No additional configuration is required. This can be used to set up cascading autocomplete controls or other combination of controls.
When the source of the additional fields is a report definition, the additional fields are only visible if they are in the main class of the report definition. If the report definition gets the additional fields through joins, during configuration of the autocomplete, the prompts are not visible.
The up down arrow icon at the right of a field indicates that autocomplete is available. You can configure styles for the autocomplete control in the Skin rule.
Deprecated autocomplete controls
Pega Platform includes the autocomplete control, pxAutoComplete. Controls available in the earlier versions of Pega Platform are deprecated.
If a section contains a deprecated autocomplete or another control for which there is an improved alternative, a warning is displayed, along with an Update Controls button. Click the button to automatically update deprecated controls in the section. Automatic update is not available for all controls; see Upgrading deprecated and outdated controls on the Pega Community.
The UI Gallery landing page contains a working example of this element. To display the gallery, in Dev Studio, click.
For another use of autocomplete, see How to use the Autocomplete control to build a list on the Pega Community.
- Adding an Autocomplete control
Use an Autocomplete control to allow the user to select a value from a possibly large set of searched text values, based on a partial string match. Pega Platform dynamically assembles and displays a list of candidate matching values after the user types one or a few characters of input.