TextBoxBuilder

Properties

WriteAction - Func

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 for ClearButton

RETURNS

Returns the current TextBoxBuilder instance.

ClearButton()

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

RETURNS

Returns the current TextBoxBuilder 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 TextBoxBuilder 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 TextBoxBuilder 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<TextBoxLabelSettingsBuilder>

The configurator for the label setting.

RETURNS

Returns the current instance of TextBoxBuilder .

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 TextBoxBuilder instance.

PrefixOptions(System.Action)

The configuration for the prefix adornment of the component.

Parameters

configurator - System.Action<TextBoxPrefixOptionsSettingsBuilder>

The configurator for the prefixoptions setting.

RETURNS

Returns the current instance of TextBoxBuilder .

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 for Readonly

RETURNS

Returns the current TextBoxBuilder instance.

Readonly()

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.

RETURNS

Returns the current TextBoxBuilder instance.

SuffixOptions(System.Action)

The configuration for the suffix adornment of the component.

Parameters

configurator - System.Action<TextBoxSuffixOptionsSettingsBuilder>

The configurator for the suffixoptions setting.

RETURNS

Returns the current instance of TextBoxBuilder .

Value(System.String)

The value of the widget.

Parameters

value - System.String

The value for Value

RETURNS

Returns the current TextBoxBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current TextBoxBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current TextBoxBuilder 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 TextBoxBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<TextBoxEventBuilder>

The client events action.

RETURNS

Returns the current TextBoxBuilder instance.

Example

Razor

 
            @(Html.Kendo().TextBox()
                  .Name("TextBox")
                  .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.