Class

RadMaskedInputBase

Initializes a new instance of the RadMaskedInputBase class.

Declaration

protected RadMaskedInputBase()

Identifies the AcceptsReturn dependency property.

Declaration

public static readonly DependencyProperty AcceptsReturnProperty

Field Value

Keyboard key code for the positive sign key on PC.

Declaration

protected const int AddSignKey = 107

Field Value

Identifies the AllowInvalidValues dependency property.

Declaration

public static readonly DependencyProperty AllowInvalidValuesProperty

Field Value

Identifies the ClearButtonStyle dependency property.

Declaration

public static readonly DependencyProperty ClearButtonStyleProperty

Field Value

Identifies the ClearCommand dependency property.

Declaration

public static readonly DependencyProperty ClearCommandProperty

Field Value

Identifies the CopyCommand dependency property.

Declaration

public static readonly DependencyProperty CopyCommandProperty

Field Value

Identifies the Culture dependency property.

Declaration

public static readonly DependencyProperty CultureProperty

Field Value

Identifies the CutCommand dependency property.

Declaration

public static readonly DependencyProperty CutCommandProperty

Field Value

Keyboard key code for the comma symbol on PC.

Declaration

protected const int DecimalCommaKey = 188

Field Value

Keyboard key code for the decimal point symbol on PC.

Declaration

protected const int DecimalPointKey = 190

Field Value

Identifies the DisplayErrorMessage dependency property.

Declaration

public static readonly DependencyProperty DisplayErrorMessageProperty

Field Value

Identifies the EmptyContent dependency property.

Declaration

public static readonly DependencyProperty EmptyContentProperty

Field Value

Identifies the EmptyContentTemplate dependency property.

Declaration

public static readonly DependencyProperty EmptyContentTemplateProperty

Field Value

Identifies the ErrorMessage dependency property.

Declaration

public static readonly DependencyProperty ErrorMessageProperty

Field Value

Identifies the ErrorMessageTemplate dependency property.

Declaration

public static readonly DependencyProperty ErrorMessageTemplateProperty

Field Value

Identifies the FormatString dependency property.

Declaration

public static readonly DependencyProperty FormatStringProperty

Field Value

Identifies the InputBehavior dependency property.

Declaration

public static readonly DependencyProperty InputBehaviorProperty

Field Value

Identifies the IsClearButtonVisible dependency property.

Declaration

public static readonly DependencyProperty IsClearButtonVisibleProperty

Field Value

Identifies the IsLastPositionEditable dependency property.

Declaration

public static readonly DependencyProperty IsLastPositionEditableProperty

Field Value

Identifies the IsMaskValid dependency property.

Declaration

public static readonly DependencyProperty IsMaskValidProperty

Field Value

Identifies the IsReadOnly dependency property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Identifies the Mask dependency property.

Declaration

public static readonly DependencyProperty MaskProperty

Field Value

Keyboard key code for the negative sign key on PC.

Declaration

protected const int NegativeSignKey = 189

Field Value

Identifies the OriginalValue dependency property.

Declaration

public static readonly DependencyProperty OriginalValueProperty

Field Value

Identifies the PasteCommand dependency property.

Declaration

public static readonly DependencyProperty PasteCommandProperty

Field Value

Identifies the Placeholder dependency property.

Declaration

public static readonly DependencyProperty PlaceholderProperty

Field Value

Identifies the SectionsNavigationMode dependency property.

Declaration

public static readonly DependencyProperty SectionsNavigationModeProperty

Field Value

Identifies the SelectionOnFocus dependency property.

Declaration

public static readonly DependencyProperty SelectionOnFocusProperty

Field Value

Identifies the SpinMode dependency property.

Declaration

public static readonly DependencyProperty SpinModeProperty

Field Value

Identifies the TextBoxStyle dependency property.

Declaration

public static readonly DependencyProperty TextBoxStyleProperty

Field Value

Identifies the TextMode dependency property.

Declaration

public static readonly DependencyProperty TextModeProperty

Field Value

Gets the Text of the control.

Declaration

public static readonly DependencyProperty TextProperty

Field Value

Identifies the UpdateValueEvent dependency property.

Declaration

public static readonly DependencyProperty UpdateValueEventProperty

Field Value

Identifies the ValueChanged routed event.

Declaration

public static readonly RoutedEvent ValueChangedEvent

Field Value

Identifies the ValueChanging routed event.

Declaration

public static readonly RoutedEvent ValueChangingEvent

Field Value

Identifies the ValueToTextConverter dependency property.

Declaration

public static readonly DependencyProperty ValueToTextConverterProperty

Field Value

Gets or sets a value indicating whether newline is accepted when the mask supports multiline.

Declaration

public bool AcceptsReturn { get; set; }

Property Value

Remarks

Gets or sets whether invalid values should be accepted as valid and set to the Value property.

Declaration

public bool AllowInvalidValues { get; set; }

Property Value

Gets the allowed DateTime tokens from the TokenLocator.

Declaration

protected static string AllowedDateTimeTokens { get; }

Property Value

Gets the allowed modifier tokens from the TokenLocator.

Declaration

protected static string AllowedModifierTokens { get; }

Property Value

Gets the allowed Numeric tokens from the TokenLocator.

Declaration

protected static string AllowedNumericTokens { get; }

Property Value

Represents a StringBuilder for performing string operations.

Declaration

protected StringBuilder Builder { get; set; }

Property Value

Gets or sets the ClearButton style.

Declaration

public Style ClearButtonStyle { get; set; }

Property Value

Gets or sets the Clear command.

Declaration

public DelegateCommand ClearCommand { get; set; }

Property Value

Gets or sets the Copy command.

Declaration

public DelegateCommand CopyCommand { get; set; }

Property Value

Gets or sets the Culture.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Remarks

Gets or sets the Cut command.

Declaration

public DelegateCommand CutCommand { get; set; }

Property Value

Gets the DisplayErrorMessage.

Declaration

public string DisplayErrorMessage { get; }

Property Value

Remarks

Gets the ending position in the MaskedText that can be edited.

Declaration

protected int EditableTextEnd { get; }

Property Value

Gets the length of the editable section in the MaskedText.

Declaration

protected int EditableTextLength { get; }

Property Value

Gets the starting position in the MaskedText that can be edited.

Declaration

protected int EditableTextStart { get; }

Property Value

Gets or sets the Empty content.

Declaration

public object EmptyContent { get; set; }

Property Value

Remarks

Gets or sets the template of the EmptyContent.

Declaration

public DataTemplate EmptyContentTemplate { get; set; }

Property Value

Gets or sets the Error message.

Declaration

public string ErrorMessage { get; set; }

Property Value

Gets or sets the template of the ErrorMessage.

Declaration

public DataTemplate ErrorMessageTemplate { get; set; }

Property Value

Contains the escaped positions of the MaskedText.

Declaration

[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists")]
protected List<int> EscapedPositions { get; set; }

Property Value

Gets or sets the formatting string used to format the Text value.

Declaration

public string FormatString { get; set; }

Property Value

Gets or sets the InputBehavior.

Declaration

public InputBehavior InputBehavior { get; set; }

Property Value

Remarks

Gets or sets the resolved InputBehavior.

Declaration

protected virtual InputBehavior InputBehaviorResolved { get; }

Property Value

Gets or sets whether the clear button is visible.

Declaration

public bool IsClearButtonVisible { get; set; }

Property Value

Gets or sets a value indicating whether this instance is last position editable.

Declaration

public bool IsLastPositionEditable { get; set; }

Property Value

Gets or sets whether the control's mask is valid.

Declaration

public bool IsMaskValid { get; }

Property Value

Gets or sets whether the control is IsReadOnly.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Gets or sets a value indicating whether the control is currently reverting its value.

Declaration

protected bool IsRevertingValue { get; set; }

Property Value

Gets or sets value indicating whether the control is one-way bound.

Declaration

protected bool IsUsingOneWayBinding { get; }

Property Value

Specifies whether the Value is being changed from the ValueInternal property.

Declaration

protected bool IsValueChangingFromInternal { get; set; }

Property Value

Specifies whether the ValueInternal is being synched from the Value property.

Declaration

protected bool IsValueInternalSync { get; set; }

Property Value

Contains the literal positions of the MaskedText.

Declaration

[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists")]
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
protected List<int> LiteralPositions { get; set; }

Property Value

Gets or sets the Mask.

Declaration

public string Mask { get; set; }

Property Value

Gets or sets the resolved Mask.

Declaration

protected string MaskResolved { get; set; }

Property Value

The resolved masked text.

Declaration

protected virtual string MaskedTextResolved { get; }

Property Value

Gets or sets the OriginalValue.

Declaration

public object OriginalValue { get; set; }

Property Value

Gets or sets the Paste command.

Declaration

public DelegateCommand PasteCommand { get; set; }

Property Value

Gets or sets the Placeholder.

Declaration

[TypeConverter(typeof(CharConverter))]
public char Placeholder { get; set; }

Property Value

Remarks

Gets or sets the sections navigation mode.

Declaration

public SectionsNavigationMode SectionsNavigationMode { get; set; }

Property Value

Gets or sets the Selection length.

Declaration

public int SelectionLength { get; set; }

Property Value

Gets or sets the SelectionOnFocus.

Declaration

public SelectionOnFocus SelectionOnFocus { get; set; }

Property Value

Remarks

Gets or sets the Selection start.

Declaration

[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]
public int SelectionStart { get; set; }

Property Value

Contains the Separators of the Mask.

Declaration

[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists")]
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
protected List<Separator> Separators { get; set; }

Property Value

Gets or sets the SpinMode.

Declaration

public SpinMode SpinMode { get; set; }

Property Value

Identifies the Text dependency property.

Declaration

public string Text { get; set; }

Property Value

Gets the style of the TextBox.

Declaration

public Style TextBoxStyle { get; set; }

Property Value

Gets or sets the TextMode.

Declaration

public TextMode TextMode { get; set; }

Property Value

Remarks

Gets or sets the UpdateValueEvent.

Declaration

public UpdateValueEvent UpdateValueEvent { get; set; }

Property Value

Remarks

Gets or sets a value whether the base class should apply base navigation.

Declaration

protected virtual bool UseBaseNavigation { get; }

Property Value

Gets or sets the ValueToTextConverter.

Declaration

public IValueConverter ValueToTextConverter { get; set; }

Property Value

Spins the control.

Declaration

public void CallSpin(bool isUp)

Parameters

Gets a value indicating whether the char can be modified when no mask.

Declaration

protected virtual bool CanModifyChar(char character)

Parameters

Returns

Gets a value indicating whether the char can be replaced when no mask.

Declaration

protected virtual bool CanReplaceChar(char character)

Parameters

Returns

Checks the value of a DependencyProperty for validation errors.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "1#")]
protected void CheckForDataValidationErrors(DependencyProperty prop, ref MaskValidationResult result)

Parameters

Clears the selection when no mask.

Declaration

protected virtual void ClearSelectionNoMask()

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

Declaration

protected abstract string CoerceDisplayTextOverride()

Returns

Initial process of the text receives from the IME input.

Declaration

protected virtual string CoerceImeInputString(string text)

Parameters

Returns

Coerces the ValueInternal property from the Value property.

Declaration

protected abstract void CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the Value property from the ValueInternal property.

Declaration

protected abstract void CoerceStronglyTypeValueFromInternalValueOverride()

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

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "0#")]
protected abstract string CoerceTextInternalOverride(ref int selectionStart)

Parameters

Returns

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

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "0#")]
protected abstract string CoerceTextOverride(ref int selectionStart)

Parameters

Returns

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

Declaration

protected abstract bool CoerceValueOverride()

Returns

Clones a Binding and sets its Mode to TwoWay and UpdateSourceTrigger to Explicit.

Declaration

protected static Binding CopyBinding(Binding bindingToCopy)

Parameters

Returns

Remarks

Finds the next available position in the MaskedTextResolved.

Declaration

protected virtual int FindNextAvailablePosition(bool forward, int position)

Parameters

Returns

Finds the next position with separator.

Declaration

[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "2#")]
protected virtual int FindNextSeparatorPosition(bool forward, int position, out Separator separator)

Parameters

Returns

Remarks

Finds the next separator position when no mask.

Declaration

protected virtual int FindNextSeparatorPosition(int position)

Parameters

Returns

Finds the previous available position when no mask.

Declaration

protected virtual int FindPreviousAvailablePositionNoMask()

Returns

Finds the previous separator position.

Declaration

protected virtual int FindPreviousSeparatorPosition(int position)

Parameters

Returns

Gets the offset from the right.

Declaration

protected virtual int GetRightOffset()

Returns

Gets the valid char for a position.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "1#")]
[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "3#")]
protected abstract string GetValidCharOverride(char character, ref int position, bool? forwardSpin, out bool isValid)

Parameters

Returns

Handles the Back key when no mask.

Declaration

protected virtual void HandleBackKeyNoMask()

Process the input when Backspace has been pressed and the mask in not "".

Declaration

protected virtual void HandleBackKeyWithMask()

Process the input when Backspace has been pressed, the mask in not "" and there is a selection.

Declaration

protected virtual void HandleBackKeyWithMaskSelected()

Called, when the Clear command is invoked.

Declaration

protected virtual void HandleClearOverride()

Handles the Delete key when no mask.

Declaration

protected virtual void HandleDeleteKeyNoMask()

Handles the Divide key.

Declaration

protected virtual bool HandleDivideKey()

Returns

Handles the Enter key.

Declaration

protected virtual bool HandleEnterKey()

Returns

Handles the left key down.

Declaration

protected virtual void HandleLeftKey()

Handles the Multiply key.

Declaration

protected virtual bool HandleMultiplyKey()

Returns

Handles the paste operation.

Declaration

protected virtual void HandlePaste()

Handles paste operation in no-mask scenarios.

Declaration

[SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate")]
[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "1#")]
protected virtual bool HandlePasteNoMask(object value, out object returnString)

Parameters

Returns

Handles the paste operation.

Declaration

[SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate")]
[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "1#")]
protected virtual bool HandlePasteOverride(object value, out object returnString)

Parameters

Returns

Handles the Space key.

Declaration

protected virtual bool HandleSpaceKey()

Returns

Handle the spin of the value.

Declaration

protected virtual void HandleSpin(int position, bool? forwardSpin)

Parameters

Handles the spin when no mask.

Declaration

protected virtual void HandleSpinNoMask(bool isUp)

Parameters

Handles the Subtract key.

Declaration

protected virtual bool HandleSubstractKey()

Returns

Handles the tab key when no mask.

Declaration

protected virtual bool HandleTabKeyNoMask()

Returns

Handles the key press of an Unknown key with a specific key code.

Declaration

protected virtual bool HandleUnknownKeyOverride(int keyCode)

Parameters

Returns

Inserts a new character when no mask.

Declaration

protected virtual void InsertCharNoMask(char character)

Parameters

Gets a value indicating whether the char is valid when no mask.

Declaration

protected virtual bool IsCharValid(char character)

Parameters

Returns

Performs validation on the masked text.

Declaration

protected virtual MaskValidationResult IsMaskValidOverride()

Returns

Checks whether a specific character is a placeholder.

Declaration

protected virtual bool IsPlaceholder(char character)

Parameters

Returns

Checks whether a specific index is a placeholder.

Declaration

protected virtual bool IsPlaceholder(int index)

Parameters

Returns

Checks whether a specific string is a placeholder.

Declaration

protected virtual bool IsPlaceholder(string value)

Parameters

Returns

Checks whether a specific character is a separator.

Declaration

protected virtual bool IsSeparator(char character)

Parameters

Returns

Checks whether a specific character is a separator.

Declaration

[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "1#")]
protected virtual bool IsSeparator(char character, out Separator separator)

Parameters

Returns

Checks whether a specified string is a separator.

Declaration

protected virtual bool IsSeparator(string value)

Parameters

Returns

Checks whether a specified string is a separator.

Declaration

[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "1#")]
protected virtual bool IsSeparator(string value, out Separator separator)

Parameters

Returns

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

Declaration

protected virtual bool IsSeparatorNoMask(char character)

Parameters

Returns

Moves characters to the left in Currency and Numeric Input.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "1#")]
[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "0#")]
protected virtual void MoveCharactersInInsertBehavior(ref int position, char inputSymbol, bool forward)

Parameters

Moves a group characters from the specified position to the left (forward) or right (backward) one position from the last Placeholder.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "0#")]
protected virtual void MoveCharactersInInsertBehaviorOverride(ref int position, char character, bool forward)

Parameters

Remarks

Handles ApplicationCommand.Cut execution.

Declaration

protected void OnApplicationCut(object sender, ExecutedRoutedEventArgs e)

Parameters

Handles ApplicationCommand.Paste execution.

Declaration

protected void OnApplicationPaste(object sender, ExecutedRoutedEventArgs e)

Parameters

Declaration

public override void OnApplyTemplate()

Creates automation peer.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Executed when the Culture changes.

Declaration

protected virtual void OnCultureChanged()

Called when control is loaded.

Declaration

protected virtual void OnLoadedOverride(object sender, RoutedEventArgs e)

Parameters

When the mouse enters the control.

Declaration

protected override void OnMouseEnter(MouseEventArgs e)

Parameters

When the mouse leaves the control.

Declaration

protected override void OnMouseLeave(MouseEventArgs e)

Parameters

Handles the MouseWheel.

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

Invoked when an unhandled System.Windows.Input.Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameters

Executes when the focus is obtained.

Declaration

protected virtual int OnSelectionOnFocus(SelectionOnFocus selectionOnFocus)

Parameters

Returns

Called when the control is unloaded.

Declaration

protected virtual void OnUnloadedOverride(object sender, RoutedEventArgs e)

Parameters

Executed when the Value property changes.

Declaration

protected static void OnValueChangedBase(DependencyObject d, DependencyPropertyChangedEventArgs args, bool processValueChanged)

Parameters

Parses the Mask property and sets the MaskedText.

Declaration

protected abstract string ParseMask()

Returns

Process the input when a key has been pressed.

Declaration

protected virtual void ProcessChar(char inputSymbol)

Parameters

Removes number of characters from the internal text when no mask.

Declaration

protected virtual void Remove(int start, int length, bool checkPositions = true)

Parameters

Replaces a char when no mask.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "1#")]
protected virtual void ReplaceChar(StringBuilder text, ref int position)

Parameters

When BackSpace or Delete are pressed, replaces the current char with PlaceHolder.

Declaration

protected virtual void ReplacePositionWithPlaceholder(int position, bool useSnapshot, bool forward)

Parameters

Resets the theme.

Declaration

public void ResetTheme()

Selects the whole text.

Declaration

public void SelectAll()

Sets the DefaultStyleKey for the control.

Declaration

protected virtual void SetDefaultStyleKey()

Sets the offset from the right.

Declaration

protected virtual void SetFromRightOffset(int offset)

Parameters

Method that sets predefined separators.

Declaration

protected virtual void SetSeparators(params Separator[] separatorsArray)

Parameters

Checks whether a specified string starts with a separator.

Declaration

[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "2#")]
protected virtual bool StartsWithSeparator(StringBuilder text, bool forward, out Separator separator)

Parameters

Returns

Checks whether a specified string starts with a separator.

Declaration

[SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "3#")]
[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "2#")]
protected virtual bool StartsWithSeparator(StringBuilder text, bool forward, out Separator separator, ref int offset)