Class
TelerikMaskedTextBox

The Telerik Masked TextBox class.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikMaskedTextBox : TextBoxBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikInputBase<string>TextBoxBaseTelerikMaskedTextBox

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members TextBoxBase.OnParametersSetAsync()TextBoxBase.OnAfterRenderAsync(bool)TextBoxBase.Dispose()TextBoxBase.InitJsComponentAsync()TextBoxBase.UpdateValueDebounced(string)TextBoxBase.TitleTextBoxBase.PlaceholderTextBoxBase.DataSmartPasteDescriptionAttributeTextBoxBase.WidthTextBoxBase.NameTextBoxBase.DebounceDelayTextBoxBase.ReadOnlyTextBoxBase.AutoCapitalizeTextBoxBase.SpellCheckTelerikInputBase<string>.OnInitializedAsync()TelerikInputBase<string>.FocusAsync()TelerikInputBase<string>.CascadedEditContextTelerikInputBase<string>.FloatingLabelTelerikInputBase<string>.IdTelerikInputBase<string>.EnabledTelerikInputBase<string>.TabIndexTelerikInputBase<string>.ValueExpressionTelerikInputBase<string>.ValueChangedTelerikInputBase<string>.ValueTelerikInputBase<string>.OnChangeTelerikInputBase<string>.OnBlurTelerikInputBase<string>.AriaLabelTelerikInputBase<string>.AriaLabelledByTelerikInputBase<string>.AriaDescribedByTelerikInputBase<string>.ValidateOnTelerikInputBase<string>.InputModeBaseComponent.ShouldRender()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)

Constructors

TelerikMaskedTextBox()

Declaration

cs-api-definition
public TelerikMaskedTextBox()

Properties

EnableWebMcpTools

Enables WebMCP tool registration for this MaskedTextBox. When true, MaskedTextBox operations are exposed as tools discoverable by AI models through the browser. Default value is false.

Declaration

cs-api-definition
[Parameter]
public bool EnableWebMcpTools { get; set; }

Property Value

bool

FillMode

Specifies the fill mode of the MaskedTextBox.

Declaration

cs-api-definition
[Parameter]
public override string FillMode { get; set; }

Property Value

string

Overrides TextBoxBase.FillMode

IncludeLiterals

Specifies whether to include literals in the raw value. Defaults to false.

Declaration

cs-api-definition
[Parameter]
public bool IncludeLiterals { get; set; }

Property Value

bool

Mask

Represents the current mask. If no mask is set, the component behaves as a standard type="text" input.

Declaration

cs-api-definition
[Parameter]
public string Mask { get; set; }

Property Value

string

MaskOnFocus

Specifies whether the mask should be shown on focus for empty value.

Declaration

cs-api-definition
[Parameter]
public bool MaskOnFocus { get; set; }

Property Value

bool

MaskedTextBoxPrefixTemplate

The content of the MaskedTextBox prefix.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MaskedTextBoxPrefixTemplate { get; set; }

Property Value

RenderFragment

MaskedTextBoxSettings

Provides configuration for WebMCP tools, such as a Name to distinguish this MaskedTextBox from others on the same page.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MaskedTextBoxSettings { get; set; }

Property Value

RenderFragment

MaskedTextBoxSuffixTemplate

The content of the MaskedTextBox suffix.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MaskedTextBoxSuffixTemplate { get; set; }

Property Value

RenderFragment

Prompt

Represents a prompt character for the masked value. Defaults to "_".

Declaration

cs-api-definition
[Parameter]
public char Prompt { get; set; }

Property Value

char

PromptPlaceholder

Indicates a character which represents an empty position in the raw value. Defaults to " ".

Declaration

cs-api-definition
[Parameter]
public char? PromptPlaceholder { get; set; }

Property Value

char?

Rounded

Specifies the roundness of the MaskedTextBox.

Declaration

cs-api-definition
[Parameter]
public override string Rounded { get; set; }

Property Value

string

Overrides TextBoxBase.Rounded

ShowClearButton

Specifies whether the clear button should be displayed.

Declaration

cs-api-definition
[Parameter]
public bool ShowClearButton { get; set; }

Property Value

bool

ShowPrefixSeparator

Defines whether the prefix separator should be shown. The default value is true.

Declaration

cs-api-definition
[Parameter]
public bool ShowPrefixSeparator { get; set; }

Property Value

bool

ShowSuffixSeparator

Defines whether the suffix separator should be shown. The default value is true.

Declaration

cs-api-definition
[Parameter]
public bool ShowSuffixSeparator { get; set; }

Property Value

bool

Size

Specifies the Size of the text MaskedTextBox.

Declaration

cs-api-definition
[Parameter]
public override string Size { get; set; }

Property Value

string

Overrides TextBoxBase.Size

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderInternalAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderInternalAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides TextBoxBase.OnAfterRenderInternalAsync(bool)

OnParametersSetInternalAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetInternalAsync()

Returns

Task

Overrides TextBoxBase.OnParametersSetInternalAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides TelerikInputBase<string>.SetParametersAsync(ParameterView)