Type Ahead Text control

The Type Ahead Text control auto fills text based on the selection service attached to it. This control is most commonly used to auto fill selections and allows for faster input as well as error prevention.

Configuration properties

Set or modify configuration properties for the control, such as appearance and behavior properties, in the Configuration properties tab.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor, you are setting the value for the large screen size. The other screen sizes inherit this value.

Theme definitions: Theme definitions specify the colors and styles for a control and determine the appearance of the control. You can preview the look and feel of controls in the theme editor. See Themes.

The appearance configuration properties for the Type Ahead Text control are shown in the following table:

Table 1. Appearance configuration properties for the Type Ahead Text control
Appearance configuration property	Description	Data type
Width	Specifies the width of the control. You can specify the width in `px` (pixels), `%` (percent), or `em` units. For example, `50px`, `20%`, or `0.4em`. If no unit type is specified, `px` is assumed. By default, no width is specified.	`String`
Height	Specifies the width of the control. You can specify the width in `px` (pixels), `%` (percent), or `em` units. For example, `50px`, `20%`, or `0.4em`. If no unit type is specified, `px` is assumed. By default, no width is specified.	`String`
Label placement	Specifies one of the following label placement locations for the control: Top: The label is placed at the top of the control. Left: The label is placed at the left of the control. The default value is Top.	`String`

The behavior configuration properties for the Type Ahead Text control are shown in the following table:

Table 2. Behavior configuration properties for the Type Ahead Text control
Behavior configuration property	Description	Data type
Tab index	Specifies the tabbing sequence index of the form control. The tab indices start at 1 and may be set sparsely. By default, no tabbing sequence index is specified.	`Integer`
Placeholder text	Text that is displayed when no text is entered.	`String`

The items configuration properties for the Type Ahead Text control are shown in the following table:

Table 3. Items configuration properties for the Type Ahead Text control
Items configuration property	Description	Data type
Item lookup mode	Specifies the method you can use to populate the selection list. The available options are: `Start Empty`, `Items From Service`, `Items From List`, .	`String`
Type-ahead items service	A service flow with appropriate Ajax service that populates the type-ahead list. The service is used when the lookup mode is `Items From Service`.	`Ajax Service`
Items list	Items to populate the type-ahead list. The Item input data is used only if the item lookup mode is set to `Items From List`.	`String[]`

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events.

The Type Ahead Text control has the following types of event handlers:

On load: Activated when the view is loaded, for example
me.setPlaceholder(${Data1}.getValue())
On change: Activated when the binding data changes, for example
${Service1}.setInputData(me.getText());${Service1}.execute()

Methods

For detailed information about the available methods for the Type Ahead Text control, see the JavaScript documentation.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.