Back to all docs
API Reference / Telerik.Windows.Controls / RadMaskedTextInput

Class
RadMaskedTextInput

Represents the RadMaskedTextInput control.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Input.dll

Syntax:
cs-api-definition
[TelerikToolboxCategory("Input")]
[Themable]
public class RadMaskedTextInput : RadMaskedSectionBase

Inheritance: objectRadMaskedInputBaseRadMaskedSectionBaseRadMaskedTextInput

Derived Classes: DateRangeMaskedInput

Inherited Members RadMaskedInputBase.DecimalPointKeyRadMaskedInputBase.DecimalCommaKeyRadMaskedInputBase.NegativeSignKeyRadMaskedInputBase.AddSignKeyRadMaskedInputBase.ValueChangedEventRadMaskedInputBase.ValueChangingEventRadMaskedInputBase.AllowInvalidValuesPropertyRadMaskedInputBase.AcceptsReturnPropertyRadMaskedInputBase.CopyCommandPropertyRadMaskedInputBase.ClearCommandPropertyRadMaskedInputBase.ClearButtonStylePropertyRadMaskedInputBase.CulturePropertyRadMaskedInputBase.CutCommandPropertyRadMaskedInputBase.EmptyContentPropertyRadMaskedInputBase.EmptyContentTemplatePropertyRadMaskedInputBase.ErrorMessagePropertyRadMaskedInputBase.ErrorMessageTemplatePropertyRadMaskedInputBase.FormatStringPropertyRadMaskedInputBase.DisplayErrorMessagePropertyRadMaskedInputBase.InputBehaviorPropertyRadMaskedInputBase.IsClearButtonVisiblePropertyRadMaskedInputBase.IsLastPositionEditablePropertyRadMaskedInputBase.IsReadOnlyPropertyRadMaskedInputBase.IsMaskValidPropertyRadMaskedInputBase.MaskPropertyRadMaskedInputBase.OriginalValuePropertyRadMaskedInputBase.PasteCommandPropertyRadMaskedInputBase.PlaceholderPropertyRadMaskedInputBase.SelectionOnFocusPropertyRadMaskedInputBase.SectionsNavigationModePropertyRadMaskedInputBase.SpinModePropertyRadMaskedInputBase.TextBoxStylePropertyRadMaskedInputBase.TextModePropertyRadMaskedInputBase.UpdateValueEventPropertyRadMaskedInputBase.ValueToTextConverterPropertyRadMaskedInputBase.TextPropertyRadMaskedInputBase.CallSpin(bool)RadMaskedInputBase.SelectAll()RadMaskedInputBase.ResetTheme()RadMaskedInputBase.ReplacePositionWithPlaceholder(int, bool, bool)RadMaskedInputBase.TrimTextStart(string, params char[])RadMaskedInputBase.CopyBinding(Binding)RadMaskedInputBase.OnValueChangedBase(DependencyObject, DependencyPropertyChangedEventArgs, bool)RadMaskedInputBase.OnMouseWheel(MouseWheelEventArgs)RadMaskedInputBase.OnCreateAutomationPeer()RadMaskedInputBase.UpdateEditableTextEndPositions()RadMaskedInputBase.HandleMultiplyKey()RadMaskedInputBase.HandleDivideKey()RadMaskedInputBase.OnApplicationPaste(object, ExecutedRoutedEventArgs)RadMaskedInputBase.OnApplicationCut(object, ExecutedRoutedEventArgs)RadMaskedInputBase.HandlePaste()RadMaskedInputBase.CheckForDataValidationErrors(DependencyProperty, ref MaskValidationResult)RadMaskedInputBase.IsSeparator(char)RadMaskedInputBase.IsSeparator(char, out Separator)RadMaskedInputBase.IsSeparator(string)RadMaskedInputBase.IsSeparator(string, out Separator)RadMaskedInputBase.IsPlaceholder(char)RadMaskedInputBase.IsPlaceholder(string)RadMaskedInputBase.IsPlaceholder(int)RadMaskedInputBase.StartsWithSeparator(StringBuilder, bool, out Separator)RadMaskedInputBase.StartsWithSeparator(StringBuilder, bool, out Separator, ref int)RadMaskedInputBase.OnCultureChanged()RadMaskedInputBase.SetSeparators(params Separator[])RadMaskedInputBase.FindNextSeparatorPosition(bool, int, out Separator)RadMaskedInputBase.HandleUnknownKeyOverride(int)RadMaskedInputBase.HandleLeftKey()RadMaskedInputBase.HandleClearOverride()RadMaskedInputBase.MoveCharactersInInsertBehaviorOverride(ref int, char, bool)RadMaskedInputBase.OnMouseEnter(MouseEventArgs)RadMaskedInputBase.OnMouseLeave(MouseEventArgs)RadMaskedInputBase.SetDefaultStyleKey()RadMaskedInputBase.HandleBackKeyWithMask()RadMaskedInputBase.HandleBackKeyWithMaskSelected()RadMaskedInputBase.OnPreviewKeyDown(KeyEventArgs)RadMaskedInputBase.OnUnloadedOverride(object, RoutedEventArgs)RadMaskedInputBase.GetRightOffset()RadMaskedInputBase.SetFromRightOffset(int)RadMaskedInputBase.IsCharValid(char)RadMaskedInputBase.CanModifyChar(char)RadMaskedInputBase.CanReplaceChar(char)RadMaskedInputBase.HandleDeleteKeyNoMask()RadMaskedInputBase.HandleTabKeyNoMask()RadMaskedInputBase.HandleSpinNoMask(bool)RadMaskedInputBase.FindPreviousSeparatorPosition(int)RadMaskedInputBase.FindPreviousAvailablePositionNoMask()RadMaskedInputBase.FindNextSeparatorPosition(int)RadMaskedInputBase.Remove(int, int, bool)RadMaskedInputBase.ReplaceChar(StringBuilder, ref int)RadMaskedInputBase.ClearSelectionNoMask()RadMaskedInputBase.AllowedNumericTokensRadMaskedInputBase.AllowedDateTimeTokensRadMaskedInputBase.AllowedModifierTokensRadMaskedInputBase.IsUsingOneWayBindingRadMaskedInputBase.IsValueChangingFromInternalRadMaskedInputBase.IsValueInternalSyncRadMaskedInputBase.SeparatorsRadMaskedInputBase.BuilderRadMaskedInputBase.EscapedPositionsRadMaskedInputBase.LiteralPositionsRadMaskedInputBase.MaskResolvedRadMaskedInputBase.EditableTextStartRadMaskedInputBase.EditableTextEndRadMaskedInputBase.EditableTextLengthRadMaskedInputBase.IsRevertingValueRadMaskedInputBase.InputBehaviorResolvedRadMaskedInputBase.UseBaseNavigationRadMaskedInputBase.AllowInvalidValuesRadMaskedInputBase.AcceptsReturnRadMaskedInputBase.CopyCommandRadMaskedInputBase.ClearCommandRadMaskedInputBase.ClearButtonStyleRadMaskedInputBase.CultureRadMaskedInputBase.CutCommandRadMaskedInputBase.EmptyContentRadMaskedInputBase.EmptyContentTemplateRadMaskedInputBase.ErrorMessageRadMaskedInputBase.ErrorMessageTemplateRadMaskedInputBase.FormatStringRadMaskedInputBase.DisplayErrorMessageRadMaskedInputBase.InputBehaviorRadMaskedInputBase.IsClearButtonVisibleRadMaskedInputBase.IsLastPositionEditableRadMaskedInputBase.IsReadOnlyRadMaskedInputBase.IsMaskValidRadMaskedInputBase.MaskRadMaskedInputBase.OriginalValueRadMaskedInputBase.PasteCommandRadMaskedInputBase.PlaceholderRadMaskedInputBase.SelectionLengthRadMaskedInputBase.SelectionStartRadMaskedInputBase.SectionsNavigationModeRadMaskedInputBase.SelectionOnFocusRadMaskedInputBase.SpinModeRadMaskedInputBase.TextRadMaskedInputBase.TextBoxStyleRadMaskedInputBase.TextModeRadMaskedInputBase.UpdateValueEventRadMaskedInputBase.ValueToTextConverterRadMaskedInputBase.ValueChangedRadMaskedInputBase.ValueChanging

Constructors

RadMaskedTextInput()

Initializes a new instance of the RadMaskedTextInput class.

Declaration

cs-api-definition
public RadMaskedTextInput()

Fields

ValidationRegexProperty

Identifies the ValidationRegex dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValidationRegexProperty

Field Value

DependencyProperty

ValueModeProperty

Identifies the ValueMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueModeProperty

Field Value

DependencyProperty

ValueProperty

Identifies the Value dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueProperty

Field Value

DependencyProperty

Properties

MaskedTextResolved

Gets the resolved masked text.

Declaration

cs-api-definition
protected override string MaskedTextResolved { get; }

Property Value

string

Overrides RadMaskedInputBase.MaskedTextResolved

ValidationRegex

Gets or sets the string used for the additional Regex validation.

Declaration

cs-api-definition
public string ValidationRegex { get; set; }

Property Value

string

Value

Gets or sets the Value property.

Declaration

cs-api-definition
public string Value { get; set; }

Property Value

string

ValueMode

Gets or sets the ValueMode property. It determines the way Value property is formatted - with or without mask literals, placeholders.

Declaration

cs-api-definition
public ValueMode ValueMode { get; set; }

Property Value

ValueMode

Methods

CoerceDisplayTextOverride()

The text has changed and the DisplayText has to be coerced against the Text.

Declaration

cs-api-definition
protected override string CoerceDisplayTextOverride()

Returns

string

Returns the display text.

Overrides RadMaskedInputBase.CoerceDisplayTextOverride()

CoerceImeInputString(string)

Initial process of the text receives from the IME input.

Declaration

cs-api-definition
protected override string CoerceImeInputString(string text)

Parameters

text

string

The initial text received from the IME.

Returns

string

Overrides RadMaskedInputBase.CoerceImeInputString(string)

CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the ValueInternal property from the Value property.

Declaration

cs-api-definition
protected override void CoerceInternalValueFromStronglyTypeValueOverride()

Overrides RadMaskedInputBase.CoerceInternalValueFromStronglyTypeValueOverride()

CoerceStronglyTypeValueFromInternalValueOverride()

Coerces the Value property from the ValueInternal property.

Declaration

cs-api-definition
protected override void CoerceStronglyTypeValueFromInternalValueOverride()

Overrides RadMaskedInputBase.CoerceStronglyTypeValueFromInternalValueOverride()

CoerceTextInternalOverride(ref int)

The internal value has changed and the Text has to be coerced against the ValueInternal.

Declaration

cs-api-definition
protected override string CoerceTextInternalOverride(ref int selectionStart)

Parameters

selectionStart

int

The selection start.

Returns

string

Returns the string coerced from ValueInternal.

Overrides RadMaskedInputBase.CoerceTextInternalOverride(ref int)

CoerceTextOverride(ref int)

The value has changed and the Text has to be coerced against the value.

Declaration

cs-api-definition
protected override string CoerceTextOverride(ref int selectionStart)

Parameters

selectionStart

int

The selection start.

Returns

string

Returns the string to be coerced.

Overrides RadMaskedInputBase.CoerceTextOverride(ref int)

CoerceValueOverride()

The text has changed and the value has to be coerced against the text.

Declaration

cs-api-definition
protected override bool CoerceValueOverride()

Returns

bool

Returns true if the value can be coerced.

Overrides RadMaskedInputBase.CoerceValueOverride()

FindNextAvailablePosition(bool, int)

Finds the next editable position after delete or backspace press. Skips literals if needed.

Declaration

cs-api-definition
protected override int FindNextAvailablePosition(bool forward, int position)

Parameters

forward

bool

position

int

Returns

int

Overrides RadMaskedInputBase.FindNextAvailablePosition(bool, int)

GetFormattedValue(string)

Formats the TextInternal property based on the ValueMode value and passes the result to the Value.

Declaration

cs-api-definition
protected virtual string GetFormattedValue(string textInternal)

Parameters

textInternal

string

Returns

string

GetNextChar(ITokenValidationRule, char, bool?)

Retrieves the next char.

Declaration

cs-api-definition
protected virtual char GetNextChar(ITokenValidationRule rule, char spinValue, bool? forwardSpin)

Parameters

rule

ITokenValidationRule

Currently used rule.

spinValue

char

The char which is currently spin.

forwardSpin

bool?

Direction of spin.

Returns

char

GetSectionsFromMaskedTextOverride()

When overridden gets the sections' position from the MaskedText.

Declaration

cs-api-definition
public virtual Dictionary<int, string> GetSectionsFromMaskedTextOverride()

Returns

Dictionary<int, string>

Returns a dictionary with the sections.

Remarks

The key of the items is the position of the section, the value is the string representation of the section.

GetValidCharOverride(char, ref int, bool?, out bool)

Gets the valid char for a position.

Declaration

cs-api-definition
protected override string GetValidCharOverride(char character, ref int position, bool? forwardSpin, out bool isValid)

Parameters

character

char

The character to be validated.

position

int

Position in the MaskedText to validate.

forwardSpin

bool?

True if a forward spin is applied, false for backward spin, null for no spin.

isValid

bool

True if the character is valid for this position.

Returns

string

Returns the result valid character for the specified position.

Overrides RadMaskedInputBase.GetValidCharOverride(char, ref int, bool?, out bool)

HandleBackKeyNoMask()

Handles the Back key when no mask.

Declaration

cs-api-definition
protected override void HandleBackKeyNoMask()

Overrides RadMaskedInputBase.HandleBackKeyNoMask()

HandleEnterKey()

Handles the Enter key.

Declaration

cs-api-definition
protected override bool HandleEnterKey()

Returns

bool

Returns a value indicating whether event should be handled or not.

Overrides RadMaskedInputBase.HandleEnterKey()

HandlePasteNoMask(object, out object)

Handles paste operation in no-mask scenarios.

Declaration

cs-api-definition
protected override bool HandlePasteNoMask(object value, out object returnString)

Parameters

value

object

returnString

object

Returns

bool

Overrides RadMaskedInputBase.HandlePasteNoMask(object, out object)

HandlePasteOverride(object, out object)

Handles the paste operation.

Declaration

cs-api-definition
protected override bool HandlePasteOverride(object value, out object returnString)

Parameters

value

object

The value to be pasted.

returnString

object

Returns the string representation of the value.

Returns

bool

Returns true if the value can be pasted.

Overrides RadMaskedInputBase.HandlePasteOverride(object, out object)

HandleSpaceKey()

Handles the Space key.

Declaration

cs-api-definition
protected override bool HandleSpaceKey()

Returns

bool

Returns a value indicating whether event should be handled or not.

Overrides RadMaskedInputBase.HandleSpaceKey()

HandleSpin(int, bool?)

Handle the spin of the value.

Declaration

cs-api-definition
protected override void HandleSpin(int position, bool? forwardSpin)

Parameters

position

int

Position of spin.

forwardSpin

bool?

Direction of spin.

Overrides RadMaskedInputBase.HandleSpin(int, bool?)

HandleSubstractKey()

Handles the Subtract key.

Declaration

cs-api-definition
protected override bool HandleSubstractKey()

Returns

bool

Returns a value indicating whether event should be handled or not.

Overrides RadMaskedInputBase.HandleSubstractKey()

InsertCharNoMask(char)

Inserts a new character when no mask.

Declaration

cs-api-definition
protected override void InsertCharNoMask(char character)

Parameters

character

char

Overrides RadMaskedInputBase.InsertCharNoMask(char)

IsMaskValidOverride()

Performs validation on the masked text.

Declaration

cs-api-definition
protected override MaskValidationResult IsMaskValidOverride()

Returns

MaskValidationResult

Returns validation result information.

Overrides RadMaskedInputBase.IsMaskValidOverride()

IsSeparatorNoMask(char)

Gets a value indicating whether a char is a separator when no mask.

Declaration

cs-api-definition
protected override bool IsSeparatorNoMask(char character)

Parameters

character

char

Returns

bool

Overrides RadMaskedInputBase.IsSeparatorNoMask(char)

MoveCharactersInInsertBehavior(ref int, char, bool)

Move characters to left and adjusts the caret position when BackSpace/Delete is pressed.

Declaration

cs-api-definition
protected override void MoveCharactersInInsertBehavior(ref int position, char inputSymbol, bool forward)

Parameters

position

int

inputSymbol

char

forward

bool

Overrides RadMaskedInputBase.MoveCharactersInInsertBehavior(ref int, char, bool)

OnApplyTemplate()

Called when the template applied to the element is applied. This method provides an opportunity to perform additional template-specific setup.

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides RadMaskedInputBase.OnApplyTemplate()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnLoadedOverride(object, RoutedEventArgs)

Called when control is loaded.

Declaration

cs-api-definition
protected override void OnLoadedOverride(object sender, RoutedEventArgs e)

Parameters

sender

object

The sender.

e

RoutedEventArgs

The RoutedEventArgs instance containing the event data.

Overrides RadMaskedInputBase.OnLoadedOverride(object, RoutedEventArgs)

OnSelectionOnFocus(SelectionOnFocus)

Determines the new SelectionStart position.

Declaration

cs-api-definition
protected override int OnSelectionOnFocus(SelectionOnFocus selectionOnFocus)

Parameters

selectionOnFocus

SelectionOnFocus

Returns

int

Overrides RadMaskedInputBase.OnSelectionOnFocus(SelectionOnFocus)

ParseMask()

Parses the Mask property and sets the MaskedText.

Declaration

cs-api-definition
protected override string ParseMask()

Returns

string

Returns the parsed Mask.

Overrides RadMaskedInputBase.ParseMask()

ProcessChar(char)

Inserts the input char or overwrites the current char with the input one.

Declaration

cs-api-definition
protected override void ProcessChar(char inputSymbol)

Parameters

inputSymbol

char

Overrides RadMaskedInputBase.ProcessChar(char)

RefreshSectionPositions()

Refreshes the positions of the sections.

Declaration

cs-api-definition
protected override void RefreshSectionPositions()

Overrides RadMaskedSectionBase.RefreshSectionPositions()

UpdateEditableTextEndPositionsOverride(ref int, ref int)

Updates the EditableTextEnd and EditableTextStart properties.

Declaration

cs-api-definition
protected override void UpdateEditableTextEndPositionsOverride(ref int start, ref int end)

Parameters

start

int

end

int

Overrides RadMaskedInputBase.UpdateEditableTextEndPositionsOverride(ref int, ref int)

ValueChangingOverride(RoutedEventArgs)

Performs a pre-value changing checking whether the inherited control allows the ValueChanging(ed) events to be raised.

Declaration

cs-api-definition
protected override bool ValueChangingOverride(RoutedEventArgs args)

Parameters

args

RoutedEventArgs

Returns

bool

Returns a boolean flag whether the value change has to be handled or not.

Overrides RadMaskedInputBase.ValueChangingOverride(RoutedEventArgs)

Remarks

If false is returns, the value change proceeds. If true is returned, the update is terminated.

In this article
DefinitionConstructorsRadMaskedTextInput()FieldsValidationRegexPropertyValueModePropertyValuePropertyPropertiesMaskedTextResolvedValidationRegexValueValueModeMethodsCoerceDisplayTextOverride()CoerceImeInputString(string)CoerceInternalValueFromStronglyTypeValueOverride()CoerceStronglyTypeValueFromInternalValueOverride()CoerceTextInternalOverride(ref int)CoerceTextOverride(ref int)CoerceValueOverride()FindNextAvailablePosition(bool, int)GetFormattedValue(string)GetNextChar(ITokenValidationRule, char, bool?)GetSectionsFromMaskedTextOverride()GetValidCharOverride(char, ref int, bool?, out bool)HandleBackKeyNoMask()HandleEnterKey()HandlePasteNoMask(object, out object)HandlePasteOverride(object, out object)HandleSpaceKey()HandleSpin(int, bool?)HandleSubstractKey()InsertCharNoMask(char)IsMaskValidOverride()IsSeparatorNoMask(char)MoveCharactersInInsertBehavior(ref int, char, bool)OnApplyTemplate()OnInitialized(EventArgs)OnLoadedOverride(object, RoutedEventArgs)OnSelectionOnFocus(SelectionOnFocus)ParseMask()ProcessChar(char)RefreshSectionPositions()UpdateEditableTextEndPositionsOverride(ref int, ref int)ValueChangingOverride(RoutedEventArgs)
Not finding the help you need?
Contact Support