skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class RadMaskedTextInput

Represents the RadMaskedTextInput control.

Inheritance
System.Object
RadMaskedInputBase
RadMaskedSectionBase
RadMaskedTextInput
DateRangeMaskedInput
Inherited Members
RadMaskedInputBase.DecimalPointKey
RadMaskedInputBase.DecimalCommaKey
RadMaskedInputBase.NegativeSignKey
RadMaskedInputBase.AddSignKey
RadMaskedInputBase.ValueChangedEvent
RadMaskedInputBase.ValueChangingEvent
RadMaskedInputBase.AllowInvalidValuesProperty
RadMaskedInputBase.AcceptsReturnProperty
RadMaskedInputBase.CopyCommandProperty
RadMaskedInputBase.ClearCommandProperty
RadMaskedInputBase.ClearButtonStyleProperty
RadMaskedInputBase.CultureProperty
RadMaskedInputBase.CutCommandProperty
RadMaskedInputBase.EmptyContentProperty
RadMaskedInputBase.EmptyContentTemplateProperty
RadMaskedInputBase.ErrorMessageProperty
RadMaskedInputBase.ErrorMessageTemplateProperty
RadMaskedInputBase.FormatStringProperty
RadMaskedInputBase.DisplayErrorMessageProperty
RadMaskedInputBase.InputBehaviorProperty
RadMaskedInputBase.IsClearButtonVisibleProperty
RadMaskedInputBase.IsLastPositionEditableProperty
RadMaskedInputBase.IsReadOnlyProperty
RadMaskedInputBase.IsMaskValidProperty
RadMaskedInputBase.MaskProperty
RadMaskedInputBase.OriginalValueProperty
RadMaskedInputBase.PasteCommandProperty
RadMaskedInputBase.PlaceholderProperty
RadMaskedInputBase.SelectionOnFocusProperty
RadMaskedInputBase.SectionsNavigationModeProperty
RadMaskedInputBase.SpinModeProperty
RadMaskedInputBase.TextBoxStyleProperty
RadMaskedInputBase.TextModeProperty
RadMaskedInputBase.UpdateValueEventProperty
RadMaskedInputBase.ValueToTextConverterProperty
RadMaskedInputBase.IsEmptyProperty
RadMaskedInputBase.HasErrorsProperty
RadMaskedInputBase.TextProperty
RadMaskedInputBase.CallSpin(Boolean)
RadMaskedInputBase.SelectAll()
RadMaskedInputBase.ResetTheme()
RadMaskedInputBase.ReplacePositionWithPlaceholder(Int32, Boolean, Boolean)
RadMaskedInputBase.TrimTextStart(String, Char[])
RadMaskedInputBase.CopyBinding(Binding)
RadMaskedInputBase.OnValueChangedBase(DependencyObject, DependencyPropertyChangedEventArgs, Boolean)
RadMaskedInputBase.OnMouseWheel(MouseWheelEventArgs)
RadMaskedInputBase.OnCreateAutomationPeer()
RadMaskedInputBase.UpdateEditableTextEndPositions()
RadMaskedInputBase.HandleMultiplyKey()
RadMaskedInputBase.HandleDivideKey()
RadMaskedInputBase.OnApplicationPaste(Object, ExecutedRoutedEventArgs)
RadMaskedInputBase.OnApplicationCut(Object, ExecutedRoutedEventArgs)
RadMaskedInputBase.HandlePaste()
RadMaskedInputBase.CheckForDataValidationErrors(DependencyProperty, MaskValidationResult)
RadMaskedInputBase.IsSeparator(Char)
RadMaskedInputBase.IsSeparator(Char, Separator)
RadMaskedInputBase.IsSeparator(String)
RadMaskedInputBase.IsSeparator(String, Separator)
RadMaskedInputBase.IsPlaceholder(Char)
RadMaskedInputBase.IsPlaceholder(String)
RadMaskedInputBase.IsPlaceholder(Int32)
RadMaskedInputBase.StartsWithSeparator(StringBuilder, Boolean, Separator)
RadMaskedInputBase.StartsWithSeparator(StringBuilder, Boolean, Separator, Int32)
RadMaskedInputBase.OnCultureChanged()
RadMaskedInputBase.SetSeparators(Separator[])
RadMaskedInputBase.FindNextSeparatorPosition(Boolean, Int32, Separator)
RadMaskedInputBase.HandleUnknownKeyOverride(Int32)
RadMaskedInputBase.HandleLeftKey()
RadMaskedInputBase.HandleClearOverride()
RadMaskedInputBase.MoveCharactersInInsertBehaviorOverride(Int32, Char, Boolean)
RadMaskedInputBase.OnMouseEnter(MouseEventArgs)
RadMaskedInputBase.OnMouseLeave(MouseEventArgs)
RadMaskedInputBase.SetDefaultStyleKey()
RadMaskedInputBase.HandleBackKeyWithMask()
RadMaskedInputBase.HandleBackKeyWithMaskSelected()
RadMaskedInputBase.OnPreviewKeyDown(KeyEventArgs)
RadMaskedInputBase.OnUnloadedOverride(Object, RoutedEventArgs)
RadMaskedInputBase.GetRightOffset()
RadMaskedInputBase.SetFromRightOffset(Int32)
RadMaskedInputBase.IsCharValid(Char)
RadMaskedInputBase.CanModifyChar(Char)
RadMaskedInputBase.CanReplaceChar(Char)
RadMaskedInputBase.HandleDeleteKeyNoMask()
RadMaskedInputBase.HandleTabKeyNoMask()
RadMaskedInputBase.HandleSpinNoMask(Boolean)
RadMaskedInputBase.FindPreviousSeparatorPosition(Int32)
RadMaskedInputBase.FindPreviousAvailablePositionNoMask()
RadMaskedInputBase.FindNextSeparatorPosition(Int32)
RadMaskedInputBase.Remove(Int32, Int32, Boolean)
RadMaskedInputBase.ReplaceChar(StringBuilder, Int32)
RadMaskedInputBase.ClearSelectionNoMask()
RadMaskedInputBase.AllowedNumericTokens
RadMaskedInputBase.AllowedDateTimeTokens
RadMaskedInputBase.AllowedModifierTokens
RadMaskedInputBase.IsUsingOneWayBinding
RadMaskedInputBase.IsValueChangingFromInternal
RadMaskedInputBase.IsValueInternalSync
RadMaskedInputBase.Separators
RadMaskedInputBase.Builder
RadMaskedInputBase.EscapedPositions
RadMaskedInputBase.LiteralPositions
RadMaskedInputBase.MaskResolved
RadMaskedInputBase.EditableTextStart
RadMaskedInputBase.EditableTextEnd
RadMaskedInputBase.EditableTextLength
RadMaskedInputBase.IsRevertingValue
RadMaskedInputBase.InputBehaviorResolved
RadMaskedInputBase.UseBaseNavigation
RadMaskedInputBase.AllowInvalidValues
RadMaskedInputBase.AcceptsReturn
RadMaskedInputBase.CopyCommand
RadMaskedInputBase.ClearCommand
RadMaskedInputBase.ClearButtonStyle
RadMaskedInputBase.Culture
RadMaskedInputBase.CutCommand
RadMaskedInputBase.EmptyContent
RadMaskedInputBase.EmptyContentTemplate
RadMaskedInputBase.ErrorMessage
RadMaskedInputBase.ErrorMessageTemplate
RadMaskedInputBase.FormatString
RadMaskedInputBase.DisplayErrorMessage
RadMaskedInputBase.InputBehavior
RadMaskedInputBase.IsClearButtonVisible
RadMaskedInputBase.IsLastPositionEditable
RadMaskedInputBase.IsReadOnly
RadMaskedInputBase.IsMaskValid
RadMaskedInputBase.Mask
RadMaskedInputBase.OriginalValue
RadMaskedInputBase.PasteCommand
RadMaskedInputBase.Placeholder
RadMaskedInputBase.SelectionLength
RadMaskedInputBase.SelectionStart
RadMaskedInputBase.SectionsNavigationMode
RadMaskedInputBase.SelectionOnFocus
RadMaskedInputBase.SpinMode
RadMaskedInputBase.Text
RadMaskedInputBase.TextBoxStyle
RadMaskedInputBase.TextMode
RadMaskedInputBase.UpdateValueEvent
RadMaskedInputBase.ValueToTextConverter
RadMaskedInputBase.IsEmpty
RadMaskedInputBase.HasErrors
RadMaskedInputBase.ValueChanged
RadMaskedInputBase.ValueChanging
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll

Syntax

[TelerikToolboxCategory("Input")]
[Themable]
public class RadMaskedTextInput : RadMaskedSectionBase, IThemable

Constructors

RadMaskedTextInput()

Initializes a new instance of the RadMaskedTextInput class.

Declaration
public RadMaskedTextInput()

Fields

ValidationRegexProperty

Identifies the ValidationRegex dependency property.

Declaration
public static readonly DependencyProperty ValidationRegexProperty
Field Value
System.Windows.DependencyProperty

ValueModeProperty

Identifies the ValueMode dependency property.

Declaration
public static readonly DependencyProperty ValueModeProperty
Field Value
System.Windows.DependencyProperty

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
System.Windows.DependencyProperty

Properties

MaskedTextResolved

Gets the resolved masked text.

Declaration
protected override string MaskedTextResolved { get; }
Property Value
System.String

Overrides
RadMaskedInputBase.MaskedTextResolved

ValidationRegex

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

Declaration
public string ValidationRegex { get; set; }
Property Value
System.String

Value

Gets or sets the Value property.

Declaration
public string Value { get; set; }
Property Value
System.String

ValueMode

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

Declaration
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
protected override string CoerceDisplayTextOverride()
Returns
System.String

Returns the display text.

Overrides
RadMaskedInputBase.CoerceDisplayTextOverride()

CoerceImeInputString(String)

Initial process of the text receives from the IME input.

Declaration
protected override string CoerceImeInputString(string text)
Parameters
System.String text

The initial text received from the IME.

Returns
System.String

Overrides
RadMaskedInputBase.CoerceImeInputString(String)

CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the ValueInternal property from the Value property.

Declaration
protected override void CoerceInternalValueFromStronglyTypeValueOverride()
Overrides
RadMaskedInputBase.CoerceInternalValueFromStronglyTypeValueOverride()

CoerceStronglyTypeValueFromInternalValueOverride()

Coerces the Value property from the ValueInternal property.

Declaration
protected override void CoerceStronglyTypeValueFromInternalValueOverride()
Overrides
RadMaskedInputBase.CoerceStronglyTypeValueFromInternalValueOverride()

CoerceTextInternalOverride(ref Int32)

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

Declaration
protected override string CoerceTextInternalOverride(ref int selectionStart)
Parameters
System.Int32 selectionStart

The selection start.

Returns
System.String

Returns the string coerced from ValueInternal.

Overrides
RadMaskedInputBase.CoerceTextInternalOverride(ref Int32)

CoerceTextOverride(ref Int32)

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

Declaration
protected override string CoerceTextOverride(ref int selectionStart)
Parameters
System.Int32 selectionStart

The selection start.

Returns
System.String

Returns the string to be coerced.

Overrides
RadMaskedInputBase.CoerceTextOverride(ref Int32)

CoerceValueOverride()

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

Declaration
protected override bool CoerceValueOverride()
Returns
System.Boolean

Returns true if the value can be coerced.

Overrides
RadMaskedInputBase.CoerceValueOverride()

FindNextAvailablePosition(Boolean, Int32)

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

Declaration
protected override int FindNextAvailablePosition(bool forward, int position)
Parameters
System.Boolean forward

System.Int32 position

Returns
System.Int32

Overrides
RadMaskedInputBase.FindNextAvailablePosition(Boolean, Int32)

GetFormattedValue(String)

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

Declaration
protected virtual string GetFormattedValue(string textInternal)
Parameters
System.String textInternal

Returns
System.String

GetNextChar(ITokenValidationRule, Char, Nullable<Boolean>)

Retrieves the next char.

Declaration
protected virtual char GetNextChar(ITokenValidationRule rule, char spinValue, Nullable<bool> forwardSpin)
Parameters
ITokenValidationRule rule

Currently used rule.

System.Char spinValue

The char which is currently spin.

System.Nullable<System.Boolean> forwardSpin

Direction of spin.

Returns
System.Char

GetSectionsFromMaskedTextOverride()

When overridden gets the sections' position from the MaskedText.

Declaration
public virtual Dictionary<int, string> GetSectionsFromMaskedTextOverride()
Returns
System.Collections.Generic.Dictionary<System.Int32, System.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 Int32, Nullable<Boolean>, out Boolean)

Gets the valid char for a position.

Declaration
protected override string GetValidCharOverride(char character, ref int position, Nullable<bool> forwardSpin, out bool isValid)
Parameters
System.Char character

The character to be validated.

System.Int32 position

Position in the MaskedText to validate.

System.Nullable<System.Boolean> forwardSpin

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

System.Boolean isValid

True if the character is valid for this position.

Returns
System.String

Returns the result valid character for the specified position.

Overrides
RadMaskedInputBase.GetValidCharOverride(Char, ref Int32, Nullable<Boolean>, out Boolean)

HandleBackKeyNoMask()

Handles the Back key when no mask.

Declaration
protected override void HandleBackKeyNoMask()
Overrides
RadMaskedInputBase.HandleBackKeyNoMask()

HandleEnterKey()

Handles the Enter key.

Declaration
protected override bool HandleEnterKey()
Returns
System.Boolean

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
protected override bool HandlePasteNoMask(object value, out object returnString)
Parameters
System.Object value

System.Object returnString

Returns
System.Boolean

Overrides
RadMaskedInputBase.HandlePasteNoMask(Object, out Object)

HandlePasteOverride(Object, out Object)

Handles the paste operation.

Declaration
protected override bool HandlePasteOverride(object value, out object returnString)
Parameters
System.Object value

The value to be pasted.

System.Object returnString

Returns the string representation of the value.

Returns
System.Boolean

Returns true if the value can be pasted.

Overrides
RadMaskedInputBase.HandlePasteOverride(Object, out Object)

HandleSpaceKey()

Handles the Space key.

Declaration
protected override bool HandleSpaceKey()
Returns
System.Boolean

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

Overrides
RadMaskedInputBase.HandleSpaceKey()

HandleSpin(Int32, Nullable<Boolean>)

Handle the spin of the value.

Declaration
protected override void HandleSpin(int position, Nullable<bool> forwardSpin)
Parameters
System.Int32 position

Position of spin.

System.Nullable<System.Boolean> forwardSpin

Direction of spin.

Overrides
RadMaskedInputBase.HandleSpin(Int32, Nullable<Boolean>)

HandleSubstractKey()

Handles the Subtract key.

Declaration
protected override bool HandleSubstractKey()
Returns
System.Boolean

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

Overrides
RadMaskedInputBase.HandleSubstractKey()

InsertCharNoMask(Char)

Inserts a new character when no mask.

Declaration
protected override void InsertCharNoMask(char character)
Parameters
System.Char character

Overrides
RadMaskedInputBase.InsertCharNoMask(Char)

IsMaskValidOverride()

Performs validation on the masked text.

Declaration
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
protected override bool IsSeparatorNoMask(char character)
Parameters
System.Char character

Returns
System.Boolean

Overrides
RadMaskedInputBase.IsSeparatorNoMask(Char)

MoveCharactersInInsertBehavior(ref Int32, Char, Boolean)

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

Declaration
protected override void MoveCharactersInInsertBehavior(ref int position, char inputSymbol, bool forward)
Parameters
System.Int32 position

System.Char inputSymbol

System.Boolean forward

Overrides
RadMaskedInputBase.MoveCharactersInInsertBehavior(ref Int32, Char, Boolean)

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()
Overrides
RadMaskedInputBase.OnApplyTemplate()

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnLoadedOverride(Object, RoutedEventArgs)

Called when control is loaded.

Declaration
protected override void OnLoadedOverride(object sender, RoutedEventArgs e)
Parameters
System.Object sender

The sender.

System.Windows.RoutedEventArgs e

The System.Windows.RoutedEventArgs instance containing the event data.

Overrides
RadMaskedInputBase.OnLoadedOverride(Object, RoutedEventArgs)

OnSelectionOnFocus(SelectionOnFocus)

Determines the new SelectionStart position.

Declaration
protected override int OnSelectionOnFocus(SelectionOnFocus selectionOnFocus)
Parameters
SelectionOnFocus selectionOnFocus

Returns
System.Int32

Overrides
RadMaskedInputBase.OnSelectionOnFocus(SelectionOnFocus)

ParseMask()

Parses the Mask property and sets the MaskedText.

Declaration
protected override string ParseMask()
Returns
System.String

Returns the parsed Mask.

Overrides
RadMaskedInputBase.ParseMask()

ProcessChar(Char)

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

Declaration
protected override void ProcessChar(char inputSymbol)
Parameters
System.Char inputSymbol

Overrides
RadMaskedInputBase.ProcessChar(Char)

RefreshSectionPositions()

Refreshes the positions of the sections.

Declaration
protected override void RefreshSectionPositions()
Overrides
RadMaskedSectionBase.RefreshSectionPositions()

UpdateEditableTextEndPositionsOverride(ref Int32, ref Int32)

Updates the EditableTextEnd and EditableTextStart properties.

Declaration
protected override void UpdateEditableTextEndPositionsOverride(ref int start, ref int end)
Parameters
System.Int32 start

System.Int32 end

Overrides
RadMaskedInputBase.UpdateEditableTextEndPositionsOverride(ref Int32, ref Int32)

ValueChangingOverride(RoutedEventArgs)

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

Declaration
protected override bool ValueChangingOverride(RoutedEventArgs args)
Parameters
System.Windows.RoutedEventArgs args

Returns
System.Boolean

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.

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)
EnumerableExtensions.ToEnumerable<T>(T)
Getting Started
  • Install Now
  • Demos
  • SDK Samples Browser
  • Sample Applications
Support Resources
  • Code Library
  • Knowledge Base
  • MVVM Support
  • Videos
  • GitHub SDK Repository
Community
  • Forums
  • Blogs
  • XAML Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.