typeAhead - AJAX Type ahead

Automatically fills in its parent control as users type a succession of characters that match a specified suggestion.


Other Controls


<xp:typeAhead attributes>content</xp:typeAhead>
Table 1. Essential properties
Property Description
mode Refresh mode.
minChars Minimum characters to trigger type ahead.
valueList Suggestions returned when its initial characters are entered.
valueListSeparator Suggestions separator.
tokens Client separators in the case where the user machine specifies suggestions.
ignoreCase Whether case is honored or ignored.
Table 2. All properties
Category Properties
basics binding, dojoStoreType, frequency, htmlFilter, id, ignoreCase, loaded, maxValues, minChars, mode, preventFiltering, rendered, rendererType, tokens, url
data valueList, valueListSeparator, valueMarkup, var
dojo dojoAttributes, dojoType
events onComplete, onError, onStart
styling disableTheme, themeId


Embed this control in another control to affect input to the parent control.

In Design mode, put focus on the control that is to get type ahead and click the Type Ahead tab under Properties. Checking Enable Type Ahead embeds a type ahead control in the current control.

To see the type ahead properties under All properties, you must switch to Source mode and put focus on the embedded typeAhead control (as opposed to the parent control).


This Edit Box control provides type ahead.
<xp:inputText id="inputText1" value="#{document1.subject}">
	<xp:typeAhead mode="full" minChars="1"
	valueListSeparator="#" tokens=",/" ignoreCase="true">