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

TextBoxBuilder

Methods

ClearButton(System.Boolean)

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

Parameters

value - System.Boolean

The value that configures the clearbutton.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .ClearButton(true)
            )

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 that configures the enable.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Enable(false)
            )

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<TextBoxLabelSettingsBuilder>

The action that configures the label.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Label(l => l.Content("TextBoxContent"))
            )

Placeholder(System.String)

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

Parameters

value - System.String

The value that configures the placeholder.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Placeholder("TextBoxPlaceholder")
            )

Readonly(System.Boolean)

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.

Parameters

value - System.Boolean

The value that configures the readonly.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Readonly(true)
            )

Value(System.String)

The value of the widget.

Parameters

value - System.String

The value that configures the value.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Value("TextBoxValue")
            )

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value that configures the size.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Size(ComponentSize.Medium)
            )

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value that configures the rounded.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Rounded(Rounded.Medium)
            )

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value that configures the fillmode.

Example


            @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .FillMode(FillMode.Flat)
            )

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<TextBoxEventBuilder>

The client events action.

Example


             @( Html.Kendo().TextBox()
                        .Name("TextBox")
                        .Events(events => events
                            .Change("onChange")
                        )
            )

PrefixOptions(System.Action)

The configuration for the prefix adornment of the widget.

Parameters

configurator - System.Action<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

SuffixOptions(System.Action)

The configuration for the suffix adornment of the widget.

Parameters

configurator - System.Action<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

ToComponent()

Returns the internal view component.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name of the component.

Example


            @(Html.Kendo().Grid<OrderViewModel>()
               .Name("grid")
               .Columns(columns =>
               {
                   columns.Bound(p => p.OrderID).Filterable(false);
                   columns.Bound(p => p.Freight);
               })
               .DataSource(dataSource => dataSource
                   .Ajax()
                   .PageSize(20)
                   .Read(read => read.Action("Orders_Read", "Grid"))
               )
            )

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

ModelMetadata(System.Web.Mvc.ModelMetadata)

Uses the Metadata of the Model.

Parameters

modelMetadata - System.Web.Mvc.ModelMetadata

The metadata set for the Model

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

Render()

Renders the component.

Example


            @(@Page Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" )
            @( Html.Kendo().Grid(Model)
                .Name("grid")
                .DetailTemplate(product => {
                    )
                       Product Details:
                       <div>Product Name: @( product.ProductName )</div>
                       <div>Units In Stock: @( product.UnitsInStock )</div>
                    @(
                })
                .Render();
            )

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.

ToHtmlString()

ToClientTemplate()

In this article
Not finding the help you need?