ComboBox

Example

<kendo-combobox>
    <datasource></datasource>
    <fixed-group-template></fixed-group-template>
    <footer-template></footer-template>
    <group-template></group-template>
    <header-template></header-template>
    <item-template></item-template>
    <label />
    <messages />
    <no-data-template></no-data-template>
    <popup></popup>
    <popup-animation></popup-animation>
    <prefix-options></prefix-options>
    <suffix-options></suffix-options>
    <virtual />
</kendo-combobox>

ChildTags

Tag Name Details
datasource DataSourceTagHelper
fixed-group-template TemplateTagHelper
footer-template TemplateTagHelper
group-template TemplateTagHelper
header-template TemplateTagHelper
item-template TemplateTagHelper
label ComboBoxLabelSettingsTagHelper
messages ComboBoxMessagesSettingsTagHelper
no-data-template TemplateTagHelper
popup ComboBoxPopupSettingsTagHelper
popup-animation ComboBoxAnimationSettingsTagHelper
prefix-options ComboBoxPrefixOptionsSettingsTagHelper
suffix-options ComboBoxSuffixOptionsSettingsTagHelper
virtual ComboBoxVirtualSettingsTagHelper

Attributes

Attribute Type Description
name String Sets the name of the component.
adaptive-mode AdaptiveMode Specifies the adaptive rendering of the component.
as-module Boolean
auto-bind Boolean Controls whether to bind the widget to the data source on initialization.
auto-width Boolean If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
bind-to IEnumerable<Object> The collection of data items which the data source contains.
cascade-from String Use it to set the Id of the parent ComboBox widget.Help topic showing how cascading functionality works
cascade-from-field String Defines the field to be used to filter the data source. If not defined, it is set to a field with the same name as the parent's dataValueField option.Help topic showing how cascading functionality works
cascade-from-parent-field String Defines the parent field to be used to retain value from. This value will be used further to filter the dataSource. If not defined the value from the parent's dataValueField will be used.
cascade-on-custom-value Boolean Applicable to a parent ComboBox in a cascading scenario. If set to true cascading will be triggered upon custom input in the parent widget. When set to false (default) the child will not cascade and it will be disabled upon setting custom input in the parent ComboBox. Cascade on custom values works only when cascadeFromParentField is not set for the child combo, or it points to the dataValueField of the parent.
clear-button Boolean Unless this options is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.
datasource-id String The data source id
data-text-field String The field of the data item used when searching for suggestions. This is the text that will be displayed in the list of matched results.
data-value-field String The field of the data item used when searching for suggestions. This is the value that will be displayed in the list of matched results.
delay Double The delay in milliseconds between a keystroke and when the widget displays the popup.
enable Boolean If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
enforce-min-length Boolean If set to true the widget will not show all items when the text of the search input cleared. By default the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.
fill-mode FillMode Sets a value controlling how the color is applied.
filter FilterType The filtering method used to determine the suggestions for the current value.
fixed-group-template String The template used to render the fixed header group. By default the widget displays only the value of the current group.
fixed-group-template-handler String The template used to render the fixed header group. By default the widget displays only the value of the current group.
fixed-group-template-id String The template used to render the fixed header group. By default the widget displays only the value of the current group.
fixed-group-template-view IHtmlContent The template used to render the fixed header group. By default the widget displays only the value of the current group.
is-in-client-template Boolean When placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
footer-template String The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
footer-template-handler String The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
footer-template-id String The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
footer-template-view IHtmlContent The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
group-template String The template used to render the groups. By default the widget displays only the value of the group.
group-template-handler String The template used to render the groups. By default the widget displays only the value of the group.
group-template-id String The template used to render the groups. By default the widget displays only the value of the group.
group-template-view IHtmlContent The template used to render the groups. By default the widget displays only the value of the group.
deferred Boolean Suppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
for ModelExpression An expression to be evaluated against the current model.
has-client-component Boolean
header-template String Specifies a static HTML content, which will be rendered as a header of the popup element.
header-template-handler String Specifies a static HTML content, which will be rendered as a header of the popup element.
header-template-id String Specifies a static HTML content, which will be rendered as a header of the popup element.
header-template-view IHtmlContent Specifies a static HTML content, which will be rendered as a header of the popup element.
height Double The height of the suggestion popup in pixels. The default value is 200 pixels.
highlight-first Boolean If set to true the first suggestion will be automatically highlighted.
ignore-case Boolean If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
index Double The index of the initially selected item. The index is 0 based.
min-length Double The minimum number of characters the user must type before a search is performed. Set to higher value than 1 if the search could match a lot of items.
no-data-template String The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
no-data-template-handler String The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
no-data-template-id String The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
no-data-template-view IHtmlContent The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
on-cascade String Fired when the value of the widget is changed via API or user interaction.
on-change String Fired when the value of the widget is changed by the user. As of 2015 Q3 SP1 cascading widget will trigger change event when its value is changed due to parent update.The event handler function context (available via the this keyword) will be set to the widget instance.
on-close String Fired when the popup of the widget is closed.The event handler function context (available via the this keyword) will be set to the widget instance.
on-data-bound String Fired when the widget is bound to data from its data source.The event handler function context (available via the this keyword) will be set to the widget instance.
on-filtering String Fired when the widget is about to filter the data source.The event handler function context (available via the this keyword) will be set to the widget instance.
on-open String Fired when the popup of the widget is opened by the user.The event handler function context (available via the this keyword) will be set to the widget instance.
on-select String Fired when an item from the popup is selected by the user either with mouse/tap or with keyboard navigation.
placeholder String The hint displayed by the widget when it is empty. Not set by default.
rounded Rounded Sets a value controlling the border radius.
sanitize-id Boolean
script-attributes IDictionary<String,Object>
size ComponentSize Sets the size of the component.
suggest Boolean If set to true the widget will automatically use the first suggestion as its value.
sync-value-and-text Boolean When set to true the widget will automatically set selected value to the typed custom text. Set the option to false to clear the selected value but keep the custom text.
template String The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
template-handler String The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
template-id String The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
templates IDictionary<String,String>
template-view IHtmlContent The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
text String The text of the widget used when the autoBind is set to false.
value String The value of the widget.
value-primitive Boolean Specifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
In this article
Related articles
Not finding the help you need?