AutoCompleteBuilder
Properties
WriteAction - Func
Methods
Animation(System.Boolean)
Configures the opening and closing animations of the suggestion popup.
Parameters
enable - System.Boolean
The boolean value.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@( Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Animation(false)
)
Animation(System.Action)
Configures the opening and closing animations of the suggestion popup.
Parameters
animationAction - System.Action<PopupAnimationBuilder>
The action that configures the popup animation effects.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@( Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Animation(animation => animation
.Open(open => open.SlideIn(SlideDirection.Down))
.Close(close => close.Zoom(ZoomDirection.Out))
)
)
BindTo(System.Collections.IEnumerable)
Binds the component to an IEnumerable collection.
Parameters
data - System.Collections.IEnumerable
The IEnumerable collection.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.DataTextField("CompanyName")
.BindTo(new List<Company>
{
new Company { CompanyName = "Text1" },
new Company { CompanyName = "Text2" }
}))
Filter(System.String)
The filtering method used to determine the suggestions for the current value. The default filter value is "startswith" - all data items that begin with the current component value are displayed in the suggestion popup. The supported filter values are "startswith", "endswith" and "contains".
Parameters
value - System.String
The value of the filter operator.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Filter("contains")
)
DataSource(System.Action)
Sets the DataSource configuration of the AutoComplete for remote data binding.
Parameters
configurator - System.Action<ReadOnlyDataSourceBuilder>
The action that configures the DataSource.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.DataTextField("ProductName")
.DataSource(source =>
{
source.Read(read =>
{
read.Action("GetAutoCompleteData", "Home");
})
.ServerFiltering(false);
})
)
DataSource(System.String)
Sets a standalone DataSource Component as a data source of the AutoComplete for remote data binding.
Parameters
dataSourceId - System.String
The name of the DataSource Component.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.DataTextField("ProductName")
.DataSource("dataSource1")
)
@(Html.Kendo().DataSource<ProductViewModel>()
.Name("dataSource1")
.Ajax(dataSource => dataSource
.Read(read => read.Action("Products_Read", "DataSource"))
.ServerOperation(false)
.PageSize(20)
)
)
Separator(System.String[])
The character used to separate multiple values. Empty by default. All separators will be replaced with the first array item, which acts as a default separator. Using the separator option will still bind the primitive stringe value of the input. In case you need to bind multiple data items, you can consider the MultiSelect component.
Parameters
value - System.String[]
The values for the separators.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Separator(new string[] { ", ", "; "})
)
AdaptiveTitle(System.String)
Allows customization of the title's text in the adaptive view of the component.
Parameters
value - System.String
The value for AdaptiveTitle
RETURNS
Returns the current AutoCompleteBuilder instance.
AdaptiveSubtitle(System.String)
Allows customization of the subtitle's text in the adaptive view of the component.
Parameters
value - System.String
The value for AdaptiveSubtitle
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
DataTextField(System.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.
Parameters
value - System.String
The value for DataTextField
RETURNS
Returns the current AutoCompleteBuilder instance.
Delay(System.Double)
The delay in milliseconds between a keystroke and when the widget displays the suggestion popup.
Parameters
value - System.Double
The value for Delay
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
FixedGroupTemplate(Kendo.Mvc.UI.Fluent.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.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
FooterTemplate(Kendo.Mvc.UI.Fluent.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.
RETURNS
Returns the current AutoCompleteBuilder instance.
InputMode(System.String)
Specifies the inputmode attribute of the inner <input /> element. It is used to specify the type of on-screen keyboard that should be displayed when the user focuses the input.
Parameters
value - System.String
The value for InputMode
RETURNS
Returns the current AutoCompleteBuilder instance.
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<AutoCompleteLabelSettingsBuilder>
The configurator for the label setting.
RETURNS
Returns the current instance of AutoCompleteBuilder .
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
GroupTemplate(Kendo.Mvc.UI.Fluent.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.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
HighlightFirst(System.Boolean)
If set to true the first suggestion will be automatically highlighted.
Parameters
value - System.Boolean
The value for HighlightFirst
RETURNS
Returns the current AutoCompleteBuilder instance.
HighlightFirst()
If set to true the first suggestion will be automatically highlighted.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
Messages(System.Action)
The text messages displayed in the widget. Use this option to customize or localize the messages.
Parameters
configurator - System.Action<AutoCompleteMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of AutoCompleteBuilder .
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
NoDataTemplate(Kendo.Mvc.UI.Fluent.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.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
PrefixOptions(System.Action)
The configuration for the prefix adornment of the component.
Parameters
configurator - System.Action<AutoCompletePrefixOptionsSettingsBuilder>
The configurator for the prefixoptions setting.
RETURNS
Returns the current instance of AutoCompleteBuilder .
Separator(System.String)
The character used to separate multiple values. Empty by default.
Parameters
value - System.String
The value for Separator
RETURNS
Returns the current AutoCompleteBuilder instance.
SuffixOptions(System.Action)
The configuration for the suffix adornment of the component.
Parameters
configurator - System.Action<AutoCompleteSuffixOptionsSettingsBuilder>
The configurator for the suffixoptions setting.
RETURNS
Returns the current instance of AutoCompleteBuilder .
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
RETURNS
Returns the current AutoCompleteBuilder instance.
Suggest()
If set to true the widget will automatically use the first suggestion as its value.
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
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
RETURNS
Returns the current AutoCompleteBuilder instance.
HeaderTemplate(Kendo.Mvc.UI.Fluent.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.
RETURNS
Returns the current AutoCompleteBuilder instance.
Template(System.String)
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
Parameters
value - System.String
The value for Template
RETURNS
Returns the current AutoCompleteBuilder instance.
TemplateId(System.String)
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
Returns the current AutoCompleteBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current AutoCompleteBuilder instance.
TemplateHandler(System.String)
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current AutoCompleteBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current AutoCompleteBuilder instance.
Value(System.String)
The value of the widget.
Parameters
value - System.String
The value for Value
RETURNS
Returns the current AutoCompleteBuilder instance.
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 text field. If set to false, the View-Model field will be updated with the selected item.
Parameters
value - System.Boolean
The value for ValuePrimitive
RETURNS
Returns the current AutoCompleteBuilder instance.
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 text field. If set to false, the View-Model field will be updated with the selected item.
RETURNS
Returns the current AutoCompleteBuilder instance.
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<AutoCompleteVirtualSettingsBuilder>
The configurator for the virtual setting.
RETURNS
Returns the current instance of AutoCompleteBuilder .
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.
RETURNS
Returns the current instance of AutoCompleteBuilder .
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.
RETURNS
Returns the current instance of AutoCompleteVirtualSettingsBuilder .
Filter(Kendo.Mvc.UI.FilterType)
The filtering method used to determine the suggestions for the current value.
Parameters
value - FilterType
The value for Filter
RETURNS
Returns the current AutoCompleteBuilder instance.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current AutoCompleteBuilder instance.
Rounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the border radius.
Parameters
value - Rounded
The value for Rounded
RETURNS
Returns the current AutoCompleteBuilder instance.
FillMode(Kendo.Mvc.UI.FillMode)
Sets a value controlling how the color is applied.
Parameters
value - FillMode
The value for FillMode
RETURNS
Returns the current AutoCompleteBuilder instance.
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)
Specifies the adaptive rendering of the component.
Parameters
value - AdaptiveMode
The value for AdaptiveMode
RETURNS
Returns the current AutoCompleteBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<AutoCompleteEventBuilder>
The client events action.
RETURNS
Returns the current AutoCompleteBuilder instance.
Example
@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.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.
RETURNS
Returns the current instance.
UseMvvmInitialization()
Specifies if the component should be initialized through MVVM on the client.
RETURNS
Returns the current instance.
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.