Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / TextBoxBuilder<T>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

TextBoxBuilder<T>

Class

Defines the fluent API for configuring the Kendo TextBox for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

Syntax:
C#
public class TextBoxBuilder<T> : WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>, IHtmlString

Inheritance: objectWidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>TextBoxBuilder<T>

Implements: IHtmlString

Inherited Members WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ToComponent()WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.Name(string)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.Deferred(bool)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ModelMetadata(ModelMetadata)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.HtmlAttributes(object)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.AsModule(bool)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.Render()WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ScriptAttributes(object, bool)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ToHtmlString()WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ToClientTemplate()WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.ToString()WidgetBuilderBase<TextBox<T>, TextBoxBuilder<T>>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

TextBoxBuilder(TextBox<T>)

Initializes a new instance of the TextBox class.

C#
public TextBoxBuilder(TextBox<T> component)
Parameters:componentTextBox<T>

The component.

Methods

ClearButton(bool)

If set to true, will render a button that can be used to clear the value.

C#
public TextBoxBuilder<T> ClearButton(bool value)
Parameters:valuebool

The value that configures the clearbutton.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.ClearButton(true)
)

Enable(bool)

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.

C#
public TextBoxBuilder<T> Enable(bool value)
Parameters:valuebool

The value that configures the enable.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Enable(false)
)

Events(Action<TextBoxEventBuilder>)

Configures the client-side events.

C#
public TextBoxBuilder<T> Events(Action<TextBoxEventBuilder> configurator)
Parameters:configuratorAction<TextBoxEventBuilder>

The client events action.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Events(events =&gt; events
.Change("onChange")
)
)

FillMode(FillMode)

Sets a value controlling how the color is applied.

C#
public TextBoxBuilder<T> FillMode(FillMode value)
Parameters:valueFillMode

The value that configures the fillmode.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.FillMode(FillMode.Flat)
)

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.

C#
public TextBoxBuilder<T> InputMode(string value)
Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

TextBoxBuilder<T>

Example:
C#
@(Html.Kendo().TextBox()
.Name("textBox")
.InputMode("search")
)

Label(Action<TextBoxLabelSettingsBuilder<T>>)

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.

C#
public TextBoxBuilder<T> Label(Action<TextBoxLabelSettingsBuilder<T>> configurator)
Parameters:configuratorAction<TextBoxLabelSettingsBuilder<T>>

The action that configures the label.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Label(l =&gt; l.Content("TextBoxContent"))
)

Placeholder(string)

The hint displayed by the widget when it is empty. Not set by default.

C#
public TextBoxBuilder<T> Placeholder(string value)
Parameters:valuestring

The value that configures the placeholder.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Placeholder("TextBoxPlaceholder")
)

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

The configuration for the prefix adornment of the widget.

C#
public TextBoxBuilder<T> PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)
Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

TextBoxBuilder<T>

Readonly(bool)

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly by default and allows user input.

C#
public TextBoxBuilder<T> Readonly(bool value)
Parameters:valuebool

The value that configures the readonly.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Readonly(true)
)

Rounded(Rounded)

Sets a value controlling the border radius.

C#
public TextBoxBuilder<T> Rounded(Rounded value)
Parameters:valueRounded

The value that configures the rounded.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Rounded(Rounded.Medium)
)

Size(ComponentSize)

Sets the size of the component.

C#
public TextBoxBuilder<T> Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Size(ComponentSize.Medium)
)

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

The configuration for the suffix adornment of the widget.

C#
public TextBoxBuilder<T> SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)
Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

TextBoxBuilder<T>

Value(string)

The value of the widget.

C#
public TextBoxBuilder<T> Value(string value)
Parameters:valuestring

The value that configures the value.

Returns:

TextBoxBuilder<T>

Example:
C#
@( Html.Kendo().TextBox()
.Name("TextBox")
.Value("TextBoxValue")
)
In this article
DefinitionConstructorsTextBoxBuilder(TextBox<T>)MethodsClearButton(bool)Enable(bool)Events(Action<TextBoxEventBuilder>)FillMode(FillMode)InputMode(string)Label(Action<TextBoxLabelSettingsBuilder<T>>)Placeholder(string)PrefixOptions(Action<PrefixOptionsSettingsBuilder>)Readonly(bool)Rounded(Rounded)Size(ComponentSize)SuffixOptions(Action<SuffixOptionsSettingsBuilder>)Value(string)
Not finding the help you need?
Contact Support