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

MaskedTextBoxBuilder

Class

Defines the fluent interface for configuring the MaskedTextBox component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class MaskedTextBoxBuilder : WidgetBuilderBase<MaskedTextBox, MaskedTextBoxBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<MaskedTextBox, MaskedTextBoxBuilder>MaskedTextBoxBuilder

Implements: IHtmlString

Constructors

MaskedTextBoxBuilder(MaskedTextBox)

public MaskedTextBoxBuilder(MaskedTextBox component)

Parameters:componentMaskedTextBox

Methods

ClearPromptChar(bool)

Specifies whether the MaskedTextBox will replace the prompt characters with spaces on blur. Prompt chars will be shown again on focus.

public MaskedTextBoxBuilder ClearPromptChar(bool value)

Parameters:valuebool

The value that enables the ClearPromptChar option.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.ClearPromptChar(true)
)

Culture(string)

Specifies the culture used by the MaskedTextBox.

public MaskedTextBoxBuilder Culture(string culture)

Parameters:culturestring

The value that configures the culture.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Culture("de-DE")
)

Enable(bool)

Specifies if the MaskedTextBox must be initially enabled or disabled.

public MaskedTextBoxBuilder Enable(bool value)

Parameters:valuebool

The value that enables or disables the input.

Returns:

MaskedTextBoxBuilder

Example:

@( Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Enable(false)
)

Events(Action<MaskedTextBoxEventBuilder>)

Configures the handled client-side events of the MaskedTextBox.

public MaskedTextBoxBuilder Events(Action<MaskedTextBoxEventBuilder> EventsAction)

Parameters:EventsActionAction<MaskedTextBoxEventBuilder>

The action that configures the available events.

Returns:

MaskedTextBoxBuilder

Example:

@( Html.Kendo().MaskedTextBox()
.Name("MaskedTextBox")
.Events(events =&gt;
events.Change("change")
)
)

FillMode(FillMode)

Sets the way the color is applied to the rendered MaskedTextBox.

public MaskedTextBoxBuilder FillMode(FillMode value)

Parameters:valueFillMode

The enum value that configures the fill mode.

Returns:

MaskedTextBoxBuilder

Example:

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

public MaskedTextBoxBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.InputMode("tel")
)

Label(Action<MaskedTextBoxLabelSettingsBuilder>)

Adds a label before the input. If the input has no 'id' attribute, a generated 'id' will be assigned.

public MaskedTextBoxBuilder Label(Action<MaskedTextBoxLabelSettingsBuilder> configurator)

Parameters:configuratorAction<MaskedTextBoxLabelSettingsBuilder>

The action that configures the label settings.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Label(l =&gt; l.Content("Phone number").Floating(true))
)

Mask(string)

Sets the mask of the MaskedTextBox.

public MaskedTextBoxBuilder Mask(string mask)

Parameters:maskstring

The value that configures the mask.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Mask("999 000 000")
)

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

Defines the configuration for the prefix adornment of the MaskedTextBox.

public MaskedTextBoxBuilder PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.PrefixOptions(prefix =&gt; prefix.Icon("info"))
)

PromptChar(string)

Specifies the character used to represent the absence of user input in the MaskedTextBox.

public MaskedTextBoxBuilder PromptChar(string promptChar)

Parameters:promptCharstring

The value that configures the prompt character.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.PromptChar("X")
)

Rounded(Rounded?)

Sets how much border radius is applied to the rendered MaskedTextBox.

public MaskedTextBoxBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The enum value that configures the border radius.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Rounded(Rounded.Small)
)

Rules(Action<MaskedTextBoxRulesBuilder>)

Configures the custom mask rules.

public MaskedTextBoxBuilder Rules(Action<MaskedTextBoxRulesBuilder> RulesAction)

Parameters:RulesActionAction<MaskedTextBoxRulesBuilder>

The action that configures the custom mask rules.

Returns:

MaskedTextBoxBuilder

Example:

@( Html.Kendo().MaskedTextBox()
.Name("MaskedTextBox")
.Rules(rules =&gt;
rules.Add('~', "/[+-]/")
)
)

Size(ComponentSize?)

Sets the size of the MaskedTextBox.

public MaskedTextBoxBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The enum value that configures the size.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Size(ComponentSize.Large)
)

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

Defines the configuration for the suffix adornment of the MaskedTextBox.

public MaskedTextBoxBuilder SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.SuffixOptions(suffix =&gt; suffix.Icon("lock"))
)

UnmaskOnPost(bool)

Specifies whether the MaskedTextBox will unmask the input value on form post

public MaskedTextBoxBuilder UnmaskOnPost(bool value)

Parameters:valuebool

The value that enables the unmasking of the input value.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.UnmaskOnPost(true)
)

Value(string)

Sets the initial value of the MaskedTextBox.

public MaskedTextBoxBuilder Value(string value)

Parameters:valuestring

The value that configures the initial value.

Returns:

MaskedTextBoxBuilder

Example:

@(Html.Kendo().MaskedTextBox()
.Name("maskedTextBox")
.Value("555 123 4567")
)