The DojoFilteringSelect widget defines an interface that
includes an input box with a drop-down list. It accepts a list of
acceptable value pairs that consists of two kinds of text. One is
the text to be displayed in the input box. The other one is the hidden
text to be submitted. You can also type the text and the partially
matched values will be shown in a pop-up menu below the input text
box. Unlike a DojoComboBox widget, the unmatched user text is flagged
as an error. This widget is based on the Dojo dijit.form.FilteringSelect
definition.
Properties
- name
- A string that is used when you submit the form. It is the same
as the name attribute of plain HTML elements.
- nullable
- A Boolean value that indicates whether the user is required to
enter a value into this field or not.
- value
- A string that indicates the hidden value of the input box.
- displayedValue
- A string that indicates the displayed value in the input box.
- data
- An array of values that are of any type. It is used to specify
the data for this widget. Each data entry can be a dictionary or a
record.
- idAttr
- A string that specifies the attribute name in the data items.
The string is treated as the ID of the data item.
- searchAttr
- A string that specifies the attribute name in the data items.
It will be searched while the user is typing.
- labelAttr
- A string that specifies the attribute name in the data items.
It is shown in the drop-down list.
- labelType
- A string that specifies how to interpret the labelAttr in the
data items. It can be "html" or "text".
- placeholder
- A string that is displayed in the input box but is removed as
soon as the user clicks into the field. The string is redisplayed
in the field whenever the field is empty and the user is not working
there.
- autoComplete
- A Boolean value that indicates whether user types in a partial
string and then tab out of the input box, the first entry that is
displayed in the drop-down list will be automatically copied to the
input field or not.
- invalidMessage
- A string that specifies the message to display if the value is
invalid.
- missingMessage
- A string that specifies the message to display if the value is
empty and the field is required.
- labelBehavior
- A delegate that is called for each data record to generate its
associated label attribute. If this property is specified, it will
override labelAttr.