# MaskedTextBoxBuilder

## Properties

### WriteAction - Func

## Methods

### Rules(System.Action)

Configures the custom mask rules.

#### Parameters

##### RulesAction - System.Action<[MaskedTextBoxRulesBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxrulesbuilder)>

The action that configures the custom mask rules.

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

```
 
             @(Html.Kendo().MaskedTextBox()
                        .Name("maskedTextBox")
                        .Rules(rules =>
                            rules.Add('~', "/[+-]/")
                        )
            )
             
```

### ClearPromptChar(System.Boolean)

Specifies whether the widget will replace the prompt characters with spaces on blur. Prompt chars will be shown again on focus (available since Q2 2014 SP1).

#### Parameters

##### value - `System.Boolean`

The value for ClearPromptChar

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### ClearPromptChar()

Specifies whether the widget will replace the prompt characters with spaces on blur. Prompt chars will be shown again on focus (available since Q2 2014 SP1).

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Culture(System.String)

Specifies the culture info used by the widget.

#### Parameters

##### value - `System.String`

The value for Culture

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### 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 [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Label(System.String)

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

##### label - `System.String`

The label.

#### RETURNS

Returns the current instance of [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) .

### 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<[MaskedTextBoxLabelSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxlabelsettingsbuilder)>

The configurator for the label setting.

#### RETURNS

Returns the current instance of [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) .

### Mask(System.String)

Specifies the input mask. The following mask rules are supported: 0 - Digit. Accepts any digit between 0 and 9.; 9 - Digit or space. Accepts any digit between 0 and 9, plus space.; # - Digit or space. Like 9 rule, but allows also (+) and (-) signs.; L - Letter. Restricts input to letters a-z and A-Z. This rule is equivalent to \[a-zA-Z] in regular expressions.; ? - Letter or space. Restricts input to letters a-z and A-Z. This rule is equivalent to \[a-zA-Z] in regular expressions.; & - Character. Accepts any character. The rule is equivalent to \S in regular expressions.; C - Character or space. Accepts any character. The rule is equivalent to . in regular expressions.; A - Alphanumeric. Accepts letters and digits only.; a - Alphanumeric or space. Accepts letters, digits and space only.; . - Decimal placeholder. The decimal separator will be gotten from the current culture used by Kendo.; , - Thousands placeholder. The display character will be gotten from the current culture used by Kendo. or $ - Currency symbol. The display character will be gotten from the current culture used by Kendo..

#### Parameters

##### value - `System.String`

The value for Mask

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### PrefixOptions(System.Action)

The configuration for the prefix adornment of the component.

#### Parameters

##### configurator - System.Action<[MaskedTextBoxPrefixOptionsSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxprefixoptionssettingsbuilder)>

The configurator for the prefixoptions setting.

#### RETURNS

Returns the current instance of [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) .

### PromptChar(System.String)

Specifies the character used to represent the absence of user input in the widget

#### Parameters

##### value - `System.String`

The value for PromptChar

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### SuffixOptions(System.Action)

The configuration for the suffix adornment of the component.

#### Parameters

##### configurator - System.Action<[MaskedTextBoxSuffixOptionsSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxsuffixoptionssettingsbuilder)>

The configurator for the suffixoptions setting.

#### RETURNS

Returns the current instance of [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) .

### UnmaskOnPost(System.Boolean)

Specifies whether the widget will unmask the input value on form post (available since Q1 2015).

#### Parameters

##### value - `System.Boolean`

The value for UnmaskOnPost

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### UnmaskOnPost()

Specifies whether the widget will unmask the input value on form post (available since Q1 2015).

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Value(System.String)

Specifies the value of the MaskedTextBox widget.

#### Parameters

##### value - `System.String`

The value for Value

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Enable(System.Boolean)

Enables or disables the textbox

#### Parameters

##### value - `System.Boolean`

The value for Enable

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

#### Parameters

##### value - [ComponentSize](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui/componentsize)

The value for Size

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

#### Parameters

##### value - [Rounded](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui/rounded)

The value for Rounded

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

### FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

#### Parameters

##### value - [FillMode](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui/fillmode)

The value for FillMode

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

```
 
            @(Html.Kendo().MaskedTextBox()
                  .Name("maskedTextBox")
                  .FillMode(FillMode.Solid)
             )
             
```

### Events(System.Action)

Configures the client-side events.

#### Parameters

##### configurator - System.Action<[MaskedTextBoxEventBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxeventbuilder)>

The client events action.

#### RETURNS

Returns the current [MaskedTextBoxBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/maskedtextboxbuilder) instance.

#### Example

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

The name.

#### RETURNS

Returns the current  instance.

### Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

#### Parameters

##### modelExplorer - `Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer`

The name.

#### 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 Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean,System.Boolean)

#### Parameters

##### deferred - `System.Boolean`

#### RETURNS

Returns a [DeferredWidgetBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/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.
