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

RadMaskedEntryBase

Class

Represents the base class for masked entry controls that provide input validation and formatting through mask patterns. This abstract class implements the core functionality for masked input controls with support for culture-specific formatting, custom prompt characters, and validation.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

public abstract class RadMaskedEntryBase : Layout, IRadMaskedEntry, IView, IElement, ITransform

Inheritance: objectRadMaskedEntryBase

Derived Classes: RadIPMaskedEntryRadNumericMaskedEntryRadRegexMaskedEntryRadTextMaskedEntry

Implements: IElementIRadMaskedEntryITransformIView

Constructors

RadMaskedEntryBase()

Initializes a new instance of the RadMaskedEntryBase class.

public RadMaskedEntryBase()

Fields

ActualValidationErrorMessageProperty

BindableProperty

Identifies the ActualValidationErrorMessage bindable property.

public static readonly BindableProperty ActualValidationErrorMessageProperty

AllowNullValueProperty

BindableProperty

Identifies the AllowNullValue bindable property.

public static readonly BindableProperty AllowNullValueProperty

AllowPromptAsInputProperty

BindableProperty

Identifies the AllowPromptAsInput bindable property.

public static readonly BindableProperty AllowPromptAsInputProperty

ClearButtonStyleProperty

BindableProperty

Identifies the ClearButtonStyle property.

public static readonly BindableProperty ClearButtonStyleProperty

ClearButtonVisibilityProperty

BindableProperty

Identifies the ClearButtonVisibility bindable property.

public static readonly BindableProperty ClearButtonVisibilityProperty

ControlTemplateProperty

BindableProperty

Identifies the ControlTemplate bindable property.

public static readonly BindableProperty ControlTemplateProperty

CultureProperty

BindableProperty

Identifies the Culture bindable property.

public static readonly BindableProperty CultureProperty

EntryBackgroundColorProperty

BindableProperty

Identifies the EntryBackgroundColor bindable property.

public static readonly BindableProperty EntryBackgroundColorProperty

EntryCornerRadiusProperty

BindableProperty

Identifies the EntryCornerRadius bindable property.

public static readonly BindableProperty EntryCornerRadiusProperty

FontFamilyProperty

BindableProperty

Identifies the FontFamily bindable property.

public static readonly BindableProperty FontFamilyProperty

FontSizeProperty

BindableProperty

Identifies the FontSize bindable property.

public static readonly BindableProperty FontSizeProperty

IsReadOnlyProperty

BindableProperty

Identifies the IsReadOnly bindable property.

public static readonly BindableProperty IsReadOnlyProperty

IsValueValidProperty

BindableProperty

Identifies the IsValueValid bindable property.

public static readonly BindableProperty IsValueValidProperty

KeyboardProperty

BindableProperty

Identifies the Keyboard bindable property.

public static readonly BindableProperty KeyboardProperty

MaskProperty

BindableProperty

Identifies the Mask bindable property.

public static readonly BindableProperty MaskProperty

PlaceholderProperty

BindableProperty

Identifies the Placeholder bindable property.

public static readonly BindableProperty PlaceholderProperty

PromptCharProperty

BindableProperty

Identifies the PromptChar bindable property.

public static readonly BindableProperty PromptCharProperty

TextColorProperty

BindableProperty

Identifies the TextColor bindable property.

public static readonly BindableProperty TextColorProperty

TextProperty

BindableProperty

Identifies the Text bindable property.

public static readonly BindableProperty TextProperty

ValidationErrorMessageProperty

BindableProperty

Identifies the ValidationErrorMessage bindable property.

public static readonly BindableProperty ValidationErrorMessageProperty

Properties

ActualValidationErrorMessage

string

Gets the actual error message that will be shown (in an error-label or a tooltip) when the value does not satisfy the mask requirements. When the ValidationErrorMessage property is set, the value of the ActualValidationErrorMessage property is the same as the ValidationErrorMessage. When the ValidationErrorMessage is not set, the value of the ActualValidationErrorMessage property contains a default error message.

public string ActualValidationErrorMessage { get; }

AllowNullValue

bool

Gets or sets a value indicating whether the null value is accepted. When AllowNullValue is true the Value may be set to null programatically or by pressing the Clear button.

public bool AllowNullValue { get; set; }

Implements: IRadMaskedEntry.AllowNullValue

AllowPromptAsInput

bool

Gets or sets a value indicating whether the prompt character should be treated as a valid input character or not.

public bool AllowPromptAsInput { get; set; }

Implements: IRadMaskedEntry.AllowPromptAsInput

ClearButtonStyle

Style

Gets or sets a custom style that is to be applied to the clear button. The actual style that is applied is a merger between this style and the default clear button style.

public Style ClearButtonStyle { get; set; }

ClearButtonVisibility

Gets or sets a value indicating when the clear-button (the button that clears the text when pressed) should be displayed.

public ClearButtonVisibility ClearButtonVisibility { get; set; }

ControlTemplate

Gets or sets a value that specifies the visual structure of the Control.

public ControlTemplate ControlTemplate { get; set; }

Culture

CultureInfo

Gets or sets a value indicating the culture this control will use for formatting and recognizing numbers, datetimes, timespans.

public CultureInfo Culture { get; set; }

Implements: IRadMaskedEntry.Culture

EntryBackgroundColor

Color

Gets or sets the background color of the text-area of the masked entry.

public Color EntryBackgroundColor { get; set; }

EntryCornerRadius

CornerRadius

Gets or sets the corner radius of the text-area.

public CornerRadius EntryCornerRadius { get; set; }

FontFamily

string

Gets or sets the font family of the text-area.

public string FontFamily { get; set; }

IsReadOnly

bool

Gets or sets a value indicating whether the entry is in read-only mode. When this property is set to true, the end-user can only read the text and cannot type in the entry.

public bool IsReadOnly { get; set; }

IsValueValid

bool

Gets a value indicating whether the Value property satisfies the Mask requirements.

public bool IsValueValid { get; }

Keyboard

Gets or sets the Keyboard that should be shown on mobile devices.

[TypeConverter(typeof(KeyboardTypeConverter))]
public Keyboard Keyboard { get; set; }

Implements: IRadMaskedEntry.Keyboard

Mask

string

Gets or sets the mask string of the control. The Mask property is a string of characters that constrain user input. The Mask property may contain literals and special mask characters. The type of the masked entry determines how the mask characters are interpreted.

public string Mask { get; set; }

Implements: IRadMaskedEntry.Mask

Placeholder

string

Gets or sets the placeholder text.

public string Placeholder { get; set; }

PromptChar

char

Gets or sets a value indicating the default (prompt) char. The PromptChar is the character that is displayed instead of a whitespace, and in blank spaces (not-yet-filled placeholders) in accordance to the Mask. By default the character is an underscore "_".

public char PromptChar { get; set; }

Implements: IRadMaskedEntry.PromptChar

Text

string

Gets the text of the control.

public string Text { get; }

TextColor

Color

Gets or sets the text color.

public Color TextColor { get; set; }

ValidationErrorMessage

string

Gets or set the message that will be shown (in an error-label or a tooltip) when validation fails (i.e. the Value does not satisfy the Mask requirements). If the value of this property is null or empty a default error message is used.

public string ValidationErrorMessage { get; set; }

Methods

CreateLayoutManager()

ILayoutManager

Creates and returns a layout manager for arranging child elements within this masked entry control.

protected override ILayoutManager CreateLayoutManager()

Returns:

ILayoutManager

An ILayoutManager instance that manages the layout of child elements.

Focus()

bool

Attempts to set focus to this element.

public bool Focus()

Returns:

bool

OnHandlerChanged()

Called when the handler for this view is changed. Updates the text input component to ensure proper handler association.

protected override void OnHandlerChanged()

Unfocus()

Unsets keyboard focus on this element.

public void Unfocus()

Events

ValueChanged

EventHandler<MaskedEntryValueChangedEventArgs>

An event that is raised when the Value of the control has changed.

public event EventHandler<MaskedEntryValueChangedEventArgs> ValueChanged

ValueChanging

EventHandler<MaskedEntryValueChangingEventArgs>

An event that is raised when the Value property is about to change. You can use this event and its event args to interfere with the process of updating the value.

public event EventHandler<MaskedEntryValueChangingEventArgs> ValueChanging