New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

AutoCompleteBuilder

Class

Defines the fluent API for configuring the Telerik UI for ASP.NET MVC AutoComplete

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class AutoCompleteBuilder : DropDownListBuilderBase<AutoComplete, AutoCompleteBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<AutoComplete, AutoCompleteBuilder>ListBuilderBase<AutoComplete, AutoCompleteBuilder>DropDownListBuilderBase<AutoComplete, AutoCompleteBuilder>AutoCompleteBuilder

Implements: IHtmlString

Constructors

AutoCompleteBuilder(AutoComplete)

Initializes a new instance of the AutoCompleteBuilder class.

public AutoCompleteBuilder(AutoComplete component)

Parameters:componentAutoComplete

The component.

Methods

AutoWidth(bool)

If enabled, AutoComplete automatically adjusts the width of the popup element and does not wrap up the item label. Note: Virtualized list does not support the AutoWidth functionality.

public AutoCompleteBuilder AutoWidth(bool autoWidth)

Parameters:autoWidthboolReturns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.AutoWidth(true)
)

ClearButton(bool)

Enables or disables the clear button. This button resets the component's value and triggers the Change event.

public AutoCompleteBuilder ClearButton(bool enable)

Parameters:enablebool

The boolean value.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.ClearButton(false) // Disable the clear button.
)

EnforceMinLength(bool)

If set to true, AutoComplete will not show all items when the text of the search input is cleared. By default, the AutoComplete shows all items when the text of the search input is cleared.

public AutoCompleteBuilder EnforceMinLength(bool enforceMinLength)

Parameters:enforceMinLengthboolReturns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.EnforceMinLength(true)
)

Events(Action<AutoCompleteEventBuilder>)

Configures the client-side events.

public AutoCompleteBuilder Events(Action<AutoCompleteEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<AutoCompleteEventBuilder>

The action that sets the client-side events.

Returns:

AutoCompleteBuilder

Example:

@( Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Events(events =&gt;
events.Change("onChange")
)
)

FillMode(FillMode)

Controls how the color is applied to the component.

public AutoCompleteBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.FillMode(FillMode.Solid)
)

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 FilterType values are "StartsWith" and "Contains".

public AutoCompleteBuilder Filter(FilterType filter)

Parameters:filterFilterTypeReturns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Filter(FilterType.Contains)
)

Filter(string)

public AutoCompleteBuilder Filter(string filter)

Parameters:filterstring

The value of the filter operator.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Filter("contains")
)

HighlightFirst(bool)

If set to true, the first suggestion will be automatically highlighted.

public AutoCompleteBuilder HighlightFirst(bool highlightFirst)

Parameters:highlightFirstbool

The boolean value.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.HighlightFirst(true)
)

InputMode(string)

Defines the "inputmode" attribute of the inner <input /> element. The attribute specifies the type of on-screen keyboard displayed when the user focuses the input.

public AutoCompleteBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("autoComplete")
.InputMode("search")
)

Messages(Action<MessagesSettingsBuilder>)

The text messages displayed in the AutoComplete. Use the Messages configuration to customize or localize the default messages.

public AutoCompleteBuilder Messages(Action<MessagesSettingsBuilder> configurator)

Parameters:configuratorAction<MessagesSettingsBuilder>

The action that configures the messages.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Messages(messages =&gt; messages
.NoData("No available records"))
)

MinLength(int)

Specifies the minimum number of characters the user must type before a search is performed.

public AutoCompleteBuilder MinLength(int length)

Parameters:lengthint

The value for MinLength.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.MinLength(3)
)

Placeholder(string)

The hint displayed by the AutoComplete when it is empty. It is not set by default.

public AutoCompleteBuilder Placeholder(string placeholder)

Parameters:placeholderstring

The value for the placeholder.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Placeholder("Type a customer name...")
)

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

The configuration for the prefix adornment of the widget.

public AutoCompleteBuilder PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

AutoCompleteBuilder

Rounded(Rounded?)

Configures the border radius of the component. The supported values are: "Small", "Medium", "Large", "Full", "None".

public AutoCompleteBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Rounded(Rounded.Full)
)

Separator(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.

public AutoCompleteBuilder Separator(string separator)

Parameters:separatorstring

The values for the separator.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Separator(", ")
)

Separator(string[])

public AutoCompleteBuilder Separator(string[] separators)

Parameters:separatorsstring[]

The values for the separators.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Separator(new string[2] {", ", ": " })
)

Size(ComponentSize?)

Sets the size of the component. The supported values are: "Small", "Medium", "Large", "None".

public AutoCompleteBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Size(ComponentSize.Large)
)

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

The configuration for the suffix adornment of the widget.

public AutoCompleteBuilder SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

AutoCompleteBuilder

Suggest(bool)

If set to true, AutoComplete will automatically use the first suggestion as its value.

public AutoCompleteBuilder Suggest(bool suggest)

Parameters:suggestbool

The boolean value.

Returns:

AutoCompleteBuilder

Example:

@(Html.Kendo().AutoComplete()
.Name("AutoComplete")
.Suggest(true)
)