New to Telerik UI for WPFStart a free 30-day trial

Represents the RadMaskedTextInput control.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Input.dll

Syntax:

C#
[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

Initializes a new instance of the RadMaskedTextInput class.

C#
public RadMaskedTextInput()

Fields

ValidationRegexProperty

DependencyProperty

Identifies the ValidationRegex dependency property.

C#
public static readonly DependencyProperty ValidationRegexProperty

ValueModeProperty

DependencyProperty

Identifies the ValueMode dependency property.

C#
public static readonly DependencyProperty ValueModeProperty

ValueProperty

DependencyProperty

Identifies the Value dependency property.

C#
public static readonly DependencyProperty ValueProperty

Properties

Gets the resolved masked text.

C#
protected override string MaskedTextResolved { get; }

Overrides: RadMaskedInputBase.MaskedTextResolved

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

C#
public string ValidationRegex { get; set; }

Gets or sets the Value property.

C#
public string Value { get; set; }

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

C#
public ValueMode ValueMode { get; set; }

Methods

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

C#
protected override string CoerceDisplayTextOverride()
Returns:

string

Returns the display text.

Overrides: RadMaskedInputBase.CoerceDisplayTextOverride()

Initial process of the text receives from the IME input.

C#
protected override string CoerceImeInputString(string text)
Parameters:textstring

The initial text received from the IME.

Returns:

string

Overrides: RadMaskedInputBase.CoerceImeInputString(string)

Coerces the ValueInternal property from the Value property.

C#
protected override void CoerceInternalValueFromStronglyTypeValueOverride()

Overrides: RadMaskedInputBase.CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the Value property from the ValueInternal property.

C#
protected override void CoerceStronglyTypeValueFromInternalValueOverride()

Overrides: RadMaskedInputBase.CoerceStronglyTypeValueFromInternalValueOverride()

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

C#
protected override string CoerceTextInternalOverride(ref int selectionStart)
Parameters:selectionStartint

The selection start.

Returns:

string

Returns the string coerced from ValueInternal.

Overrides: RadMaskedInputBase.CoerceTextInternalOverride(ref int)

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

C#
protected override string CoerceTextOverride(ref int selectionStart)
Parameters:selectionStartint

The selection start.

Returns:

string

Returns the string to be coerced.

Overrides: RadMaskedInputBase.CoerceTextOverride(ref int)

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

C#
protected override bool CoerceValueOverride()
Returns:

bool

Returns true if the value can be coerced.

Overrides: RadMaskedInputBase.CoerceValueOverride()

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

C#
protected override int FindNextAvailablePosition(bool forward, int position)
Parameters:forwardboolpositionintReturns:

int

Overrides: RadMaskedInputBase.FindNextAvailablePosition(bool, int)

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

C#
protected virtual string GetFormattedValue(string textInternal)
Parameters:textInternalstringReturns:

string

Retrieves the next char.

C#
protected virtual char GetNextChar(ITokenValidationRule rule, char spinValue, bool? forwardSpin)
Parameters:ruleITokenValidationRule

Currently used rule.

spinValuechar

The char which is currently spin.

forwardSpinbool?

Direction of spin.

Returns:

char

When overridden gets the sections' position from the MaskedText.

C#
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.

Gets the valid char for a position.

C#
protected override string GetValidCharOverride(char character, ref int position, bool? forwardSpin, out bool isValid)
Parameters:characterchar

The character to be validated.

positionint

Position in the MaskedText to validate.

forwardSpinbool?

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

isValidbool

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)

Handles the Back key when no mask.

C#
protected override void HandleBackKeyNoMask()

Overrides: RadMaskedInputBase.HandleBackKeyNoMask()

Handles the Enter key.

C#
protected override bool HandleEnterKey()
Returns:

bool

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

Overrides: RadMaskedInputBase.HandleEnterKey()

Handles paste operation in no-mask scenarios.

C#
protected override bool HandlePasteNoMask(object value, out object returnString)
Parameters:valueobjectreturnStringobjectReturns:

bool

Overrides: RadMaskedInputBase.HandlePasteNoMask(object, out object)

Handles the paste operation.

C#
protected override bool HandlePasteOverride(object value, out object returnString)
Parameters:valueobject

The value to be pasted.

returnStringobject

Returns the string representation of the value.

Returns:

bool

Returns true if the value can be pasted.

Overrides: RadMaskedInputBase.HandlePasteOverride(object, out object)

Handles the Space key.

C#
protected override bool HandleSpaceKey()
Returns:

bool

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

Overrides: RadMaskedInputBase.HandleSpaceKey()

Handle the spin of the value.

C#
protected override void HandleSpin(int position, bool? forwardSpin)
Parameters:positionint

Position of spin.

forwardSpinbool?

Direction of spin.

Overrides: RadMaskedInputBase.HandleSpin(int, bool?)

Handles the Subtract key.

C#
protected override bool HandleSubstractKey()
Returns:

bool

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

Overrides: RadMaskedInputBase.HandleSubstractKey()

Inserts a new character when no mask.

C#
protected override void InsertCharNoMask(char character)
Parameters:characterchar

Overrides: RadMaskedInputBase.InsertCharNoMask(char)

Performs validation on the masked text.

C#
protected override MaskValidationResult IsMaskValidOverride()
Returns:

MaskValidationResult

Returns validation result information.

Overrides: RadMaskedInputBase.IsMaskValidOverride()

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

C#
protected override bool IsSeparatorNoMask(char character)
Parameters:charactercharReturns:

bool

Overrides: RadMaskedInputBase.IsSeparatorNoMask(char)

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

C#
protected override void MoveCharactersInInsertBehavior(ref int position, char inputSymbol, bool forward)
Parameters:positionintinputSymbolcharforwardbool

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

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

C#
public override void OnApplyTemplate()

Overrides: RadMaskedInputBase.OnApplyTemplate()

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

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Called when control is loaded.

C#
protected override void OnLoadedOverride(object sender, RoutedEventArgs e)
Parameters:senderobject

The sender.

eRoutedEventArgs

The RoutedEventArgs instance containing the event data.

Overrides: RadMaskedInputBase.OnLoadedOverride(object, RoutedEventArgs)

Determines the new SelectionStart position.

C#
protected override int OnSelectionOnFocus(SelectionOnFocus selectionOnFocus)
Parameters:selectionOnFocusSelectionOnFocusReturns:

int

Overrides: RadMaskedInputBase.OnSelectionOnFocus(SelectionOnFocus)

Parses the Mask property and sets the MaskedText.

C#
protected override string ParseMask()
Returns:

string

Returns the parsed Mask.

Overrides: RadMaskedInputBase.ParseMask()

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

C#
protected override void ProcessChar(char inputSymbol)
Parameters:inputSymbolchar

Overrides: RadMaskedInputBase.ProcessChar(char)

Refreshes the positions of the sections.

C#
protected override void RefreshSectionPositions()

Overrides: RadMaskedSectionBase.RefreshSectionPositions()

Updates the EditableTextEnd and EditableTextStart properties.

C#
protected override void UpdateEditableTextEndPositionsOverride(ref int start, ref int end)
Parameters:startintendint

Overrides: RadMaskedInputBase.UpdateEditableTextEndPositionsOverride(ref int, ref int)

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

C#
protected override bool ValueChangingOverride(RoutedEventArgs args)
Parameters:argsRoutedEventArgsReturns:

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.