ComboBoxBuilder
Properties
WriteAction - Func
Methods
Animation(System.Boolean)
Use to enable or disable animation of the popup element.
Parameters
enable - System.Boolean
The boolean value.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.Animation(false) //toggle effect
)
Animation(System.Action)
Configures the animation effects of the widget.
Parameters
animationAction - System.Action<PopupAnimationBuilder>
The action which configures the animation effects.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.Animation(animation =>
{
animation.Open(open =>
{
open.SlideIn(SlideDirection.Down);
})
})
)
BindTo(System.Collections.IEnumerable)
Binds the ComboBox to an IEnumerable list.
Parameters
data - System.Collections.IEnumerable
The data source.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.DataTextField("CompanyName")
.DataValueField("CompanyID")
.BindTo(new List<Company>
{
new Company {
CompanyName = "Text1",
CompanyID = "Value1"
},
new Company {
CompanyName = "Text2",
CompanyID = "Value2"
}
}))
BindTo(System.Collections.Generic.IEnumerable)
Binds the ComboBox to a list of SelectListItem.
Parameters
dataSource - System.Collections.Generic.IEnumerable<SelectListItem>
The data source.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.BindTo(new List<SelectListItem<
{
new SelectListItem{
Text = "Text1",
Value = "Value1"
},
new SelectListItem{
Text = "Text2",
Value = "Value2"
}
}))
Items(System.Action)
Defines the items in the ComboBox
Parameters
addAction - System.Action<SelectListItemFactory>
The add action.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.Items(items =>
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
}))
DataSource(System.Action)
Sets the data source configuration of the ComboBox.
Parameters
configurator - System.Action<ReadOnlyDataSourceBuilder>
The lambda which configures the data source
DataSource(System.String)
Parameters
dataSourceId - System.String
Filter(System.String)
The filtering method used to determine the suggestions for the current value. Filtration is turned off by default. The supported filter values are startswith, endswith and contains.
Parameters
value - System.String
The value for Filter
SelectedIndex(System.Int32)
Use it to set selected item index
Parameters
value - System.Int32
Item index.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.SelectedIndex(0);
)
AutoBind(System.Boolean)
Controls whether to bind the widget to the data source on initialization.
Parameters
value - System.Boolean
The value for AutoBind
AutoWidth(System.Boolean)
If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
Parameters
value - System.Boolean
The value for AutoWidth
CascadeFrom(System.String)
Use it to set the Id of the parent ComboBox widget.Help topic showing how cascading functionality works
Parameters
value - System.String
The value for CascadeFrom
CascadeFromField(System.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
Parameters
value - System.String
The value for CascadeFromField
CascadeFromParentField(System.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.
Parameters
value - System.String
The value for CascadeFromParentField
CascadeOnCustomValue(System.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.
Parameters
value - System.Boolean
The value for CascadeOnCustomValue
CascadeOnCustomValue()
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.
ClearButton(System.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.
Parameters
value - System.Boolean
The value for ClearButton
DataTextField(System.String)
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
Parameters
value - System.String
The value for DataTextField
DataValueField(System.String)
The field of the data item that provides the value of the widget.
Parameters
value - System.String
The value for DataValueField
Delay(System.Double)
The delay in milliseconds between a keystroke and when the widget displays the popup.
Parameters
value - System.Double
The value for Delay
Enable(System.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.
Parameters
value - System.Boolean
The value for Enable
EnforceMinLength(System.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.
Parameters
value - System.Boolean
The value for EnforceMinLength
EnforceMinLength()
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.
FixedGroupTemplate(System.String)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
value - System.String
The value for FixedGroupTemplate
FixedGroupTemplateId(System.String)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
templateId - System.String
The ID of the template element for FixedGroupTemplate
FixedGroupTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for FixedGroupTemplate
FixedGroupTemplateHandler(System.String)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
templateHandler - System.String
The handler that returs the template for FixedGroupTemplate
FixedGroupTemplate(Kendo.Mvc.UI.TemplateBuilder)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the fixedgrouptemplate.
FooterTemplate(System.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.
Parameters
value - System.String
The value for FooterTemplate
FooterTemplateId(System.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.
Parameters
templateId - System.String
The ID of the template element for FooterTemplate
FooterTemplateView(Microsoft.AspNetCore.Html.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.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for FooterTemplate
FooterTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for FooterTemplate
FooterTemplate(Kendo.Mvc.UI.TemplateBuilder)
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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the footertemplate.
Label(System.Action)
Adds a label before the input. If the input has no id attribute, a generated id will be assigned. The string and the function parameters are setting the inner HTML of the label.
Parameters
configurator - System.Action<ComboBoxLabelSettingsBuilder>
The configurator for the label setting.
GroupTemplate(System.String)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
value - System.String
The value for GroupTemplate
GroupTemplateId(System.String)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
templateId - System.String
The ID of the template element for GroupTemplate
GroupTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for GroupTemplate
GroupTemplateHandler(System.String)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
templateHandler - System.String
The handler that returs the template for GroupTemplate
GroupTemplate(Kendo.Mvc.UI.TemplateBuilder)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the grouptemplate.
Height(System.Double)
The height of the suggestion popup in pixels. The default value is 200 pixels.
Parameters
value - System.Double
The value for Height
HighlightFirst(System.Boolean)
If set to true the first suggestion will be automatically highlighted.
Parameters
value - System.Boolean
The value for HighlightFirst
IgnoreCase(System.Boolean)
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
Parameters
value - System.Boolean
The value for IgnoreCase
Messages(System.Action)
The text messages displayed in the widget. Use this option to customize or localize the messages.
Parameters
configurator - System.Action<ComboBoxMessagesSettingsBuilder>
The configurator for the messages setting.
MinLength(System.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.
Parameters
value - System.Double
The value for MinLength
NoDataTemplate(System.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.
Parameters
value - System.String
The value for NoDataTemplate
NoDataTemplateId(System.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.
Parameters
templateId - System.String
The ID of the template element for NoDataTemplate
NoDataTemplateView(Microsoft.AspNetCore.Html.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.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for NoDataTemplate
NoDataTemplateHandler(System.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.
Parameters
templateHandler - System.String
The handler that returs the template for NoDataTemplate
NoDataTemplate(Kendo.Mvc.UI.TemplateBuilder)
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.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the nodatatemplate.
Placeholder(System.String)
The hint displayed by the widget when it is empty. Not set by default.
Parameters
value - System.String
The value for Placeholder
Popup(System.Action)
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
Parameters
configurator - System.Action<ComboBoxPopupSettingsBuilder>
The configurator for the popup setting.
PrefixOptions(System.Action)
The configuration for the prefix adornment of the component.
Parameters
configurator - System.Action<ComboBoxPrefixOptionsSettingsBuilder>
The configurator for the prefixoptions setting.
SuffixOptions(System.Action)
The configuration for the suffix adornment of the component.
Parameters
configurator - System.Action<ComboBoxSuffixOptionsSettingsBuilder>
The configurator for the suffixoptions setting.
Suggest(System.Boolean)
If set to true the widget will automatically use the first suggestion as its value.
Parameters
value - System.Boolean
The value for Suggest
Suggest()
If set to true the widget will automatically use the first suggestion as its value.
SyncValueAndText(System.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.
Parameters
value - System.Boolean
The value for SyncValueAndText
HeaderTemplate(System.String)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
value - System.String
The value for HeaderTemplate
HeaderTemplateId(System.String)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
templateId - System.String
The ID of the template element for HeaderTemplate
HeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for HeaderTemplate
HeaderTemplateHandler(System.String)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
templateHandler - System.String
The handler that returs the template for HeaderTemplate
HeaderTemplate(Kendo.Mvc.UI.TemplateBuilder)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the headertemplate.
Template(System.String)
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
Parameters
value - System.String
The value for Template
TemplateId(System.String)
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
Parameters
templateId - System.String
The ID of the template element for Template
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
TemplateHandler(System.String)
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
Parameters
templateHandler - System.String
The handler that returs the template for Template
Template(Kendo.Mvc.UI.TemplateBuilder)
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
Text(System.String)
The text of the widget used when the autoBind is set to false.
Parameters
value - System.String
The value for Text
Value(System.String)
The value of the widget.
Parameters
value - System.String
The value for Value
ValuePrimitive(System.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.
Parameters
value - System.Boolean
The value for ValuePrimitive
ValuePrimitive()
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.
Virtual(System.Action)
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
Parameters
configurator - System.Action<ComboBoxVirtualSettingsBuilder>
The configurator for the virtual setting.
Virtual()
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
Virtual(System.Boolean)
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
Parameters
enabled - System.Boolean
Enables or disables the virtual option.
Filter(Kendo.Mvc.UI.FilterType)
The filtering method used to determine the suggestions for the current value.
Parameters
value - FilterType
The value for Filter
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
Rounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the border radius.
Parameters
value - Rounded
The value for Rounded
FillMode(Kendo.Mvc.UI.FillMode)
Sets a value controlling how the color is applied.
Parameters
value - FillMode
The value for FillMode
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)
Specifies the adaptive rendering of the component.
Parameters
value - AdaptiveMode
The value for AdaptiveMode
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ComboBoxEventBuilder>
The client events action.
Example
@(Html.Kendo().ComboBox()
.Name("ComboBox")
.Events(events => events
.Change("onChange")
)
)
UseMvvmInitialization(System.Boolean)
Specifies if the component should be initialized through MVVM on the client.
Parameters
value - System.Boolean
The value.
UseMvvmInitialization()
Specifies if the component should be initialized through MVVM on the client.
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.