Class RadMaskedEntryBase

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.

Inheritance

System.Object

RadMaskedEntryBase

RadIPMaskedEntry

RadNumericMaskedEntry

RadRegexMaskedEntry

RadTextMaskedEntry

Namespace: Telerik.Maui.Controls

Assembly: Telerik.Maui.Controls.dll

Syntax

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

Constructors

RadMaskedEntryBase()

Initializes a new instance of the RadMaskedEntryBase class.

Declaration

public RadMaskedEntryBase()

Fields

ActualValidationErrorMessageProperty

Identifies the ActualValidationErrorMessage bindable property.

Declaration

public static readonly BindableProperty ActualValidationErrorMessageProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

AllowNullValueProperty

Identifies the AllowNullValue bindable property.

Declaration

public static readonly BindableProperty AllowNullValueProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

AllowPromptAsInputProperty

Identifies the AllowPromptAsInput bindable property.

Declaration

public static readonly BindableProperty AllowPromptAsInputProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ClearButtonStyleProperty

Identifies the ClearButtonStyle property.

Declaration

public static readonly BindableProperty ClearButtonStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ClearButtonVisibilityProperty

Identifies the ClearButtonVisibility bindable property.

Declaration

public static readonly BindableProperty ClearButtonVisibilityProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ControlTemplateProperty

Identifies the ControlTemplate bindable property.

Declaration

public static readonly BindableProperty ControlTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CultureProperty

Identifies the Culture bindable property.

Declaration

public static readonly BindableProperty CultureProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

EntryBackgroundColorProperty

Identifies the EntryBackgroundColor bindable property.

Declaration

public static readonly BindableProperty EntryBackgroundColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

EntryCornerRadiusProperty

Identifies the EntryCornerRadius bindable property.

Declaration

public static readonly BindableProperty EntryCornerRadiusProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontFamilyProperty

Identifies the FontFamily bindable property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontSizeProperty

Identifies the FontSize bindable property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsReadOnlyProperty

Identifies the IsReadOnly bindable property.

Declaration

public static readonly BindableProperty IsReadOnlyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsValueValidProperty

Identifies the IsValueValid bindable property.

Declaration

public static readonly BindableProperty IsValueValidProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

KeyboardProperty

Identifies the Keyboard bindable property.

Declaration

public static readonly BindableProperty KeyboardProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MaskProperty

Identifies the Mask bindable property.

Declaration

public static readonly BindableProperty MaskProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PlaceholderProperty

Identifies the Placeholder bindable property.

Declaration

public static readonly BindableProperty PlaceholderProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PromptCharProperty

Identifies the PromptChar bindable property.

Declaration

public static readonly BindableProperty PromptCharProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextColorProperty

Identifies the TextColor bindable property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextProperty

Identifies the Text bindable property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ValidationErrorMessageProperty

Identifies the ValidationErrorMessage bindable property.

Declaration

public static readonly BindableProperty ValidationErrorMessageProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

ActualValidationErrorMessage

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.

Declaration

public string ActualValidationErrorMessage { get; }

Property Value

System.String

AllowNullValue

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.

Declaration

public bool AllowNullValue { get; set; }

Property Value

System.Boolean

Implements

IRadMaskedEntry.AllowNullValue

AllowPromptAsInput

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

Declaration

public bool AllowPromptAsInput { get; set; }

Property Value

System.Boolean

Implements

IRadMaskedEntry.AllowPromptAsInput

ClearButtonStyle

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.

Declaration

public Style ClearButtonStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ClearButtonVisibility

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

Declaration

public ClearButtonVisibility ClearButtonVisibility { get; set; }

Property Value

Microsoft.Maui.ClearButtonVisibility

ControlTemplate

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

Declaration

public ControlTemplate ControlTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.ControlTemplate

Culture

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

Declaration

public CultureInfo Culture { get; set; }

Property Value

System.Globalization.CultureInfo

Implements

IRadMaskedEntry.Culture

EntryBackgroundColor

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

Declaration

public Color EntryBackgroundColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

EntryCornerRadius

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

Declaration

public CornerRadius EntryCornerRadius { get; set; }

Property Value

Microsoft.Maui.CornerRadius

FontFamily

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

Declaration

public string FontFamily { get; set; }

Property Value

System.String

FontSize

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

Declaration

public double FontSize { get; set; }

Property Value

System.Double

IsReadOnly

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.

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

IsValueValid

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

Declaration

public bool IsValueValid { get; }

Property Value

System.Boolean

Keyboard

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

Declaration

public Keyboard Keyboard { get; set; }

Property Value

Microsoft.Maui.Keyboard

Implements

IRadMaskedEntry.Keyboard

Mask

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.

Declaration

public string Mask { get; set; }

Property Value

System.String

Implements

IRadMaskedEntry.Mask

Placeholder

Gets or sets the placeholder text.

Declaration

public string Placeholder { get; set; }

Property Value

System.String

PromptChar

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 "_".

Declaration

public char PromptChar { get; set; }

Property Value

System.Char

Implements

IRadMaskedEntry.PromptChar

Text

Gets the text of the control.

Declaration

public string Text { get; }

Property Value

System.String

TextColor

Gets or sets the text color.

Declaration

public Color TextColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

ValidationErrorMessage

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.

Declaration

public string ValidationErrorMessage { get; set; }

Property Value

System.String

Methods

CreateLayoutManager()

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

Declaration

protected override ILayoutManager CreateLayoutManager()

Returns

Microsoft.Maui.Layouts.ILayoutManager An Microsoft.Maui.Layouts.ILayoutManager instance that manages the layout of child elements.

OnHandlerChanged()

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

Declaration

protected override void OnHandlerChanged()

Events

ValueChanged

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

Declaration

public event EventHandler<MaskedEntryValueChangedEventArgs> ValueChanged

Event Type

System.EventHandler<MaskedEntryValueChangedEventArgs>

ValueChanging

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.

Declaration

public event EventHandler<MaskedEntryValueChangingEventArgs> ValueChanging

Event Type

System.EventHandler<MaskedEntryValueChangingEventArgs>

Explicit Interface Implementations

IRadMaskedEntry.ValueChanged(MaskedEntryValueChangedEventArgs)

Declaration

void IRadMaskedEntry.ValueChanged(MaskedEntryValueChangedEventArgs args)

Parameters

MaskedEntryValueChangedEventArgs args

Implements

IRadMaskedEntry.ValueChanged(MaskedEntryValueChangedEventArgs)

IRadMaskedEntry.ValueChanging(MaskedEntryValueChangingEventArgs)

Declaration

void IRadMaskedEntry.ValueChanging(MaskedEntryValueChangingEventArgs args)

Parameters

MaskedEntryValueChangingEventArgs args

Implements

IRadMaskedEntry.ValueChanging(MaskedEntryValueChangingEventArgs)

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)