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

TextAreaBuilder

Class

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

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class TextAreaBuilder : WidgetBuilderBase<TextArea, TextAreaBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<TextArea, TextAreaBuilder>TextAreaBuilder

Implements: IHtmlString

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

Constructors

TextAreaBuilder(TextArea)

Initializes a new instance of the TextArea class.

C#
public TextAreaBuilder(TextArea component)
Parameters:componentTextArea

The component.

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Label(l =&gt; {
l.Floating(true);
l.Content("Value");
})
)

Methods

Enable(bool)

If set to false, the component will be disabled and will not allow user input. The component is enabled by default and allows user input.

C#
public TextAreaBuilder Enable(bool value)
Parameters:valuebool

The value that configures the enable.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Enable(true)
)

Events(Action<TextAreaEventBuilder>)

Configures the client-side events.

C#
public TextAreaBuilder Events(Action<TextAreaEventBuilder> configurator)
Parameters:configuratorAction<TextAreaEventBuilder>

The client events action.

Returns:

TextAreaBuilder

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

FillMode(FillMode)

Sets a value controlling how the color is applied.

C#
public TextAreaBuilder FillMode(FillMode value)
Parameters:valueFillMode

The value that configures the fillmode.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.FillMode(FillMode.Solid)
)

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 TextAreaBuilder InputMode(string value)
Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("textArea")
.InputMode("search")
)

Label(Action<TextAreaLabelSettingsBuilder>)

Adds a label before the textarea. If the textarea 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 TextAreaBuilder Label(Action<TextAreaLabelSettingsBuilder> configurator)
Parameters:configuratorAction<TextAreaLabelSettingsBuilder>

The action that configures the label.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Label(l =&gt; {
l.Floating(true);
l.Content("Value");
})
)

LayoutFlow(TextAreaLayoutFlow)

Defines the layout flow of the component.

C#
public TextAreaBuilder LayoutFlow(TextAreaLayoutFlow value)
Parameters:valueTextAreaLayoutFlow

The value that configures the layoutflow.

Returns:

TextAreaBuilder

MaxLength(double)

The maximum number of characters that the user can enter.

C#
public TextAreaBuilder MaxLength(double value)
Parameters:valuedouble

The value that configures the maxlength.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.MaxLength(112)
)

MaxRows(double)

The maximum number of visible rows to which the textarea can auto-resize. Used in combination with autoResize.

C#
public TextAreaBuilder MaxRows(double value)
Parameters:valuedouble

The value that configures the maxrows.

Returns:

TextAreaBuilder

Overflow(TextAreaOverflow)

Defines how the content overflow should be handled

C#
public TextAreaBuilder Overflow(TextAreaOverflow value)
Parameters:valueTextAreaOverflow

The value that configures the overflow.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Overflow(TextAreaOverflow.Scroll)
)

Placeholder(string)

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

C#
public TextAreaBuilder Placeholder(string value)
Parameters:valuestring

The value that configures the placeholder.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Placeholder("Value")
)

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

The configuration for the prefix adornment of the widget.

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

The action that configures the prefix options.

Returns:

TextAreaBuilder

Readonly(bool)

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

C#
public TextAreaBuilder Readonly(bool value)
Parameters:valuebool

The value that configures the readonly.

Returns:

TextAreaBuilder

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

Resize(TextAreaResize)

Defines how the component should be resized

C#
public TextAreaBuilder Resize(TextAreaResize value)
Parameters:valueTextAreaResize

The value that configures the resize.

Returns:

TextAreaBuilder

Rounded(Rounded)

Sets a value controlling the border radius.

C#
public TextAreaBuilder Rounded(Rounded value)
Parameters:valueRounded

The value that configures the rounded.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Rounded(true)
)

Rows(double)

The number of visible text lines for the control.

C#
public TextAreaBuilder Rows(double value)
Parameters:valuedouble

The value that configures the rows.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Rows(58)
)

Size(ComponentSize)

Sets the size of the component.

C#
public TextAreaBuilder Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Size(ComponentSize.Large)
)

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

The configuration for the suffix adornment of the widget.

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

The action that configures the suffix options.

Returns:

TextAreaBuilder

Value(string)

The value of the component.

C#
public TextAreaBuilder Value(string value)
Parameters:valuestring

The value that configures the value.

Returns:

TextAreaBuilder

Example:
C#
@(Html.Kendo().TextArea()
.Name("TextArea")
.Value("Value")
)
In this article
DefinitionConstructorsTextAreaBuilder(TextArea)MethodsEnable(bool)Events(Action<TextAreaEventBuilder>)FillMode(FillMode)InputMode(string)Label(Action<TextAreaLabelSettingsBuilder>)LayoutFlow(TextAreaLayoutFlow)MaxLength(double)MaxRows(double)Overflow(TextAreaOverflow)Placeholder(string)PrefixOptions(Action<PrefixOptionsSettingsBuilder>)Readonly(bool)Resize(TextAreaResize)Rounded(Rounded)Rows(double)Size(ComponentSize)SuffixOptions(Action<SuffixOptionsSettingsBuilder>)Value(string)
Not finding the help you need?
Contact Support