Class RadMaskedInputBase

Represents the base class for RadMaskedInput controls.

Inheritance
System.Object
RadMaskedInputBase
RadMaskedCurrencyInput
RadMaskedNumericInput
RadMaskedSectionBase
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll

Syntax

public abstract class RadMaskedInputBase : Control

Constructors

RadMaskedInputBase()

Initializes a new instance of the RadMaskedInputBase class.

Declaration
protected RadMaskedInputBase()

Fields

AcceptsReturnProperty

Identifies the AcceptsReturn dependency property.

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

AddSignKey

Keyboard key code for the positive sign key on PC.

Declaration
protected const int AddSignKey = 107
Field Value
System.Int32

AllowInvalidValuesProperty

Identifies the AllowInvalidValues dependency property.

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

ClearButtonStyleProperty

Identifies the ClearButtonStyle dependency property.

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

ClearCommandProperty

Identifies the ClearCommand dependency property.

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

CopyCommandProperty

Identifies the CopyCommand dependency property.

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

CultureProperty

Identifies the Culture dependency property.

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

CutCommandProperty

Identifies the CutCommand dependency property.

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

DecimalCommaKey

Keyboard key code for the comma symbol on PC.

Declaration
protected const int DecimalCommaKey = 188
Field Value
System.Int32

DecimalPointKey

Keyboard key code for the decimal point symbol on PC.

Declaration
protected const int DecimalPointKey = 190
Field Value
System.Int32

DisplayErrorMessageProperty

Identifies the DisplayErrorMessage dependency property.

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

EmptyContentProperty

Identifies the EmptyContent dependency property.

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

EmptyContentTemplateProperty

Identifies the EmptyContentTemplate dependency property.

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

ErrorMessageProperty

Identifies the ErrorMessage dependency property.

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

ErrorMessageTemplateProperty

Identifies the ErrorMessageTemplate dependency property.

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

FormatStringProperty

Identifies the FormatString dependency property.

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

InputBehaviorProperty

Identifies the InputBehavior dependency property.

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

IsClearButtonVisibleProperty

Identifies the IsClearButtonVisible dependency property.

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

IsEmptyProperty

Identifies the IsEmpty dependency property.

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

IsFocusedProperty

Identifies the IsFocused dependency property.

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

IsLastPositionEditableProperty

Identifies the IsLastPositionEditable dependency property.

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

IsMaskValidProperty

Identifies the IsMaskValid dependency property.

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

IsReadOnlyProperty

Identifies the IsReadOnly dependency property.

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

IsValidationHintVisibleProperty

Identifies the IsValidationHintVisible dependency property key.

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

MaskProperty

Identifies the Mask dependency property.

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

NegativeSignKey

Keyboard key code for the negative sign key on PC.

Declaration
protected const int NegativeSignKey = 189
Field Value
System.Int32

OriginalValueProperty

Identifies the OriginalValue dependency property.

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

PasteCommandProperty

Identifies the PasteCommand dependency property.

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

PlaceholderProperty

Identifies the Placeholder dependency property.

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

SectionsNavigationModeProperty

Identifies the SectionsNavigationMode dependency property.

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

SelectionOnFocusProperty

Identifies the SelectionOnFocus dependency property.

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

SpinModeProperty

Identifies the SpinMode dependency property.

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

TextBoxStyleProperty

Identifies the TextBoxStyle dependency property.

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

TextModeProperty

Identifies the TextMode dependency property.

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

TextProperty

Gets the Text of the control.

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

UpdateValueEventProperty

Identifies the UpdateValueEvent dependency property.

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

ValueChangedEvent

Identifies the ValueChanged routed event.

Declaration
public static readonly RoutedEvent ValueChangedEvent
Field Value
RoutedEvent

ValueChangingEvent

Identifies the ValueChanging routed event.

Declaration
public static readonly RoutedEvent ValueChangingEvent
Field Value
RoutedEvent

ValueToTextConverterProperty

Identifies the ValueToTextConverter dependency property.

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

Properties

AcceptsReturn

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

Declaration
public bool AcceptsReturn { get; set; }
Property Value
System.Boolean

Remarks

Default value is false.

AllowedDateTimeTokens

Gets the allowed DateTime tokens from the TokenLocator.

Declaration
protected static string AllowedDateTimeTokens { get; }
Property Value
System.String

AllowedModifierTokens

Gets the allowed modifier tokens from the TokenLocator.

Declaration
protected static string AllowedModifierTokens { get; }
Property Value
System.String

AllowedNumericTokens

Gets the allowed Numeric tokens from the TokenLocator.

Declaration
protected static string AllowedNumericTokens { get; }
Property Value
System.String

AllowInvalidValues

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
System.Boolean

Builder

Represents a StringBuilder for performing string operations.

Declaration
protected StringBuilder Builder { get; set; }
Property Value
System.Text.StringBuilder

ClearButtonStyle

Gets or sets the ClearButton style.

Declaration
public Style ClearButtonStyle { get; set; }
Property Value
System.Windows.Style

ClearCommand

Gets or sets the Clear command.

Declaration
public DelegateCommand ClearCommand { get; set; }
Property Value
DelegateCommand

CopyCommand

Gets or sets the Copy command.

Declaration
public DelegateCommand CopyCommand { get; set; }
Property Value
DelegateCommand

Culture

Gets or sets the Culture.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.CultureInfo

Remarks

Default culture is "en-US".

CutCommand

Gets or sets the Cut command.

Declaration
public DelegateCommand CutCommand { get; set; }
Property Value
DelegateCommand

DisplayErrorMessage

Gets the DisplayErrorMessage.

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

Remarks

A default error message will be shown unless the ErrorMessage property is not set.

EditableTextEnd

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

Declaration
protected int EditableTextEnd { get; }
Property Value
System.Int32

EditableTextLength

Gets the length of the editable section in the MaskedText.

Declaration
protected int EditableTextLength { get; }
Property Value
System.Int32

EditableTextStart

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

Declaration
protected int EditableTextStart { get; }
Property Value
System.Int32

EmptyContent

Gets or sets the Empty content.

Declaration
public object EmptyContent { get; set; }
Property Value
System.Object

Remarks

Default is an empty string.

EmptyContentTemplate

Gets or sets the template of the EmptyContent.

Declaration
public DataTemplate EmptyContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

ErrorMessage

Gets or sets the Error message.

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

ErrorMessageTemplate

Gets or sets the template of the ErrorMessage.

Declaration
public DataTemplate ErrorMessageTemplate { get; set; }
Property Value
System.Windows.DataTemplate

EscapedPositions

Contains the escaped positions of the MaskedText.

Declaration
protected List<int> EscapedPositions { get; set; }
Property Value
System.Collections.Generic.List<System.Int32>

FormatString

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

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

InputBehavior

Gets or sets the InputBehavior.

Declaration
public InputBehavior InputBehavior { get; set; }
Property Value
InputBehavior

Remarks

Default for numeric input should be Insert and for text and date input Replace.

InputBehaviorResolved

Gets or sets the resolved InputBehavior.

Declaration
protected virtual InputBehavior InputBehaviorResolved { get; }
Property Value
InputBehavior

IsClearButtonVisible

Gets or sets whether the clear button is visible.

Declaration
public bool IsClearButtonVisible { get; set; }
Property Value
System.Boolean

IsEmpty

Gets or sets the IsEmpty property.

Declaration
public bool IsEmpty { get; set; }
Property Value
System.Boolean

IsFocused

Gets the bool indicating whether the control is focused or not. This is a dependency property.

Declaration
public bool IsFocused { get; }
Property Value
System.Boolean

IsLastPositionEditable

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

Declaration
public bool IsLastPositionEditable { get; set; }
Property Value
System.Boolean

True if this instance is last position editable; otherwise, false.

IsMaskValid

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

Declaration
public bool IsMaskValid { get; }
Property Value
System.Boolean

IsMouseOver

Specifies whether the Mouse is over the control.

Declaration
protected bool IsMouseOver { get; set; }
Property Value
System.Boolean

IsReadOnly

Gets or sets whether the control is IsReadOnly.

Declaration
public bool IsReadOnly { get; set; }
Property Value
System.Boolean

IsRevertingValue

Declaration
protected bool IsRevertingValue { get; set; }
Property Value
System.Boolean

IsValidationHintVisible

Gets or sets whether the validation hint is visible.

Declaration
public bool IsValidationHintVisible { get; set; }
Property Value
System.Boolean

IsValueChangingFromInternal

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

Declaration
protected bool IsValueChangingFromInternal { get; set; }
Property Value
System.Boolean

IsValueInternalSync

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

Declaration
protected bool IsValueInternalSync { get; set; }
Property Value
System.Boolean

LiteralPositions

Contains the literal positions of the MaskedText.

Declaration
protected List<int> LiteralPositions { get; set; }
Property Value
System.Collections.Generic.List<System.Int32>

Mask

Gets or sets the Mask.

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

MaskedTextResolved

The resolved masked text.

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

MaskResolved

Gets or sets the resolved Mask.

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

OriginalValue

Gets or sets the OriginalValue.

Declaration
public object OriginalValue { get; set; }
Property Value
System.Object

PasteCommand

Gets or sets the Paste command.

Declaration
public DelegateCommand PasteCommand { get; set; }
Property Value
DelegateCommand

Placeholder

Gets or sets the Placeholder.

Declaration
public char Placeholder { get; set; }
Property Value
System.Char

Remarks

Default placeholder is "_".

SectionsNavigationMode

Gets or sets the sections navigation mode.

Declaration
public SectionsNavigationMode SectionsNavigationMode { get; set; }
Property Value
SectionsNavigationMode

The sections navigation mode.

SelectionLength

Gets or sets the Selection length.

Declaration
public int SelectionLength { get; set; }
Property Value
System.Int32

SelectionOnFocus

Gets or sets the SelectionOnFocus.

Declaration
public SelectionOnFocus SelectionOnFocus { get; set; }
Property Value
SelectionOnFocus

Remarks

Controls the selection when focus is acquired. Default is Unchanged.

SelectionStart

Gets or sets the Selection start.

Declaration
public int SelectionStart { get; set; }
Property Value
System.Int32

Separators

Contains the Separators of the Mask.

Declaration
protected List<Separator> Separators { get; set; }
Property Value
System.Collections.Generic.List<Separator>

SpinMode

Gets or sets the SpinMode.

Declaration
public SpinMode SpinMode { get; set; }
Property Value
SpinMode

Text

Identifies the Text dependency property.

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

TextBoxStyle

Gets the style of the TextBox.

Declaration
public Style TextBoxStyle { get; set; }
Property Value
System.Windows.Style

TextMode

Gets or sets the TextMode.

Declaration
public TextMode TextMode { get; set; }
Property Value
TextMode

Remarks

Controls the of format of the Text property. Default is MaskedText.

UpdateValueEvent

Gets or sets the UpdateValueEvent.

Declaration
public UpdateValueEvent UpdateValueEvent { get; set; }
Property Value
UpdateValueEvent

Remarks

Controls when the Value is updated. Default is PropertyChanged.

UseBaseNavigation

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

Declaration
protected virtual bool UseBaseNavigation { get; }
Property Value
System.Boolean

ValueToTextConverter

Gets or sets the ValueToTextConverter.

Declaration
public IValueConverter ValueToTextConverter { get; set; }
Property Value
System.Windows.Data.IValueConverter

Methods

CallSpin(Boolean)

Spins the control.

Declaration
public void CallSpin(bool isUp)
Parameters
System.Boolean isUp

True for spinning up, false for down.

CanModifyChar(Char)

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

Declaration
protected virtual bool CanModifyChar(char character)
Parameters
System.Char character

Returns
System.Boolean

CanReplaceChar(Char)

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

Declaration
protected virtual bool CanReplaceChar(char character)
Parameters
System.Char character

Returns
System.Boolean

CheckForDataValidationErrors(DependencyProperty, ref MaskValidationResult)

Checks the value of a DependencyProperty for validation errors.

Declaration
protected void CheckForDataValidationErrors(DependencyProperty prop, ref MaskValidationResult result)
Parameters
System.Windows.DependencyProperty prop

The DependencyProperty to be checked.
MaskValidationResult result

Returns the validation information.

ClearSelectionNoMask()

Clears the selection when no mask.

Declaration
protected virtual void ClearSelectionNoMask()

CoerceDisplayTextOverride()

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

Declaration
protected abstract string CoerceDisplayTextOverride()
Returns
System.String

Returns the display text.

CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the ValueInternal property from the Value property.

Declaration
protected abstract void CoerceInternalValueFromStronglyTypeValueOverride()

CoerceStronglyTypeValueFromInternalValueOverride()

Coerces the Value property from the ValueInternal property.

Declaration
protected abstract void CoerceStronglyTypeValueFromInternalValueOverride()

CoerceTextInternalOverride(ref Int32)

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

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

The selection start.
Returns
System.String

Returns the coerced text.

CoerceTextOverride(ref Int32)

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

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

The selection start.
Returns
System.String

Returns the string to be coerced.

CoerceValueOverride()

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

Declaration
protected abstract bool CoerceValueOverride()
Returns
System.Boolean

Returns true if the value can be coerced.

CopyBinding(Binding)

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

Declaration
protected static Binding CopyBinding(Binding bindingToCopy)
Parameters
System.Windows.Data.Binding bindingToCopy

The binding to copy.
Returns
System.Windows.Data.Binding

Returns the copied binding.
Remarks

This is intended to be used in scenarios, where a one-way binding is used and value change notifications are still needed.

FindNextAvailablePosition(Boolean, Int32)

Finds the next available position in the MaskedTextResolved.

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

True if the search is perform forwards, false for backwards.
System.Int32 position

The starting position of the search.
Returns
System.Int32

Returns the found position.

FindNextSeparatorPosition(Boolean, Int32, out Separator)

Finds the next position with separator.

Declaration
protected virtual int FindNextSeparatorPosition(bool forward, int position, out Separator separator)
Parameters
System.Boolean forward

The direction of the search. True for forward, false for backward.
System.Int32 position

The position from which the search starts.
Separator separator

The found separator.
Returns
System.Int32

Returns the position of the separator.
Remarks

If no position is found, the method will return the EditableTextStart or EditableTextEnd depending on the direction.

FindNextSeparatorPosition(Int32)

Finds the next separator position when no mask.

Declaration
protected virtual int FindNextSeparatorPosition(int position)
Parameters
System.Int32 position

Returns
System.Int32

FindPreviousAvailablePositionNoMask()

Finds the previous available position when no mask.

Declaration
protected virtual int FindPreviousAvailablePositionNoMask()
Returns
System.Int32

FindPreviousSeparatorPosition(Int32)

Finds the previous separator position.

Declaration
protected virtual int FindPreviousSeparatorPosition(int position)
Parameters
System.Int32 position

Returns
System.Int32

GetRightOffset()

Gets the offset from the right.

Declaration
protected virtual int GetRightOffset()
Returns
System.Int32

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

Gets the valid char for a position.

Declaration
protected abstract 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.

HandleBackKeyNoMask()

Handles the Back key when no mask.

Declaration
protected virtual void HandleBackKeyNoMask()

HandleBackKeyWithMask()

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

Declaration
protected virtual void HandleBackKeyWithMask()

HandleBackKeyWithMaskSelected()

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

Declaration
protected virtual void HandleBackKeyWithMaskSelected()

HandleClearOverride()

Called, when the Clear command is invoked.

Declaration
protected virtual void HandleClearOverride()

HandleDeleteKeyNoMask()

Handles the Delete key when no mask.

Declaration
protected virtual void HandleDeleteKeyNoMask()

HandleDivideKey()

Handles the Divide key.

Declaration
protected virtual bool HandleDivideKey()
Returns
System.Boolean

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

HandleEnterKey()

Handles the Enter key.

Declaration
protected virtual bool HandleEnterKey()
Returns
System.Boolean

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

HandleLeftKey()

Handles the left key down.

Declaration
protected virtual void HandleLeftKey()

HandleMultiplyKey()

Handles the Multiply key.

Declaration
protected virtual bool HandleMultiplyKey()
Returns
System.Boolean

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

HandlePaste()

Handles the paste operation.

Declaration
protected virtual void HandlePaste()

HandlePasteNoMask(Object, out Object)

Handles paste operation in no-mask scenarios.

Declaration
protected virtual bool HandlePasteNoMask(object value, out object returnString)
Parameters
System.Object value

System.Object returnString

Returns
System.Boolean

HandlePasteOverride(Object, out Object)

Handles the paste operation.

Declaration
protected virtual 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.

HandleSpaceKey()

Handles the Space key.

Declaration
protected virtual bool HandleSpaceKey()
Returns
System.Boolean

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

HandleSpin(Int32, Nullable<Boolean>)

Handle the spin of the value.

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

Position of spin.
System.Nullable<System.Boolean> forwardSpin

Direction of spin.

HandleSpinNoMask(Boolean)

Handles the spin when no mask.

Declaration
protected virtual void HandleSpinNoMask(bool isUp)
Parameters
System.Boolean isUp

HandleSubstractKey()

Handles the Subtract key.

Declaration
protected virtual bool HandleSubstractKey()
Returns
System.Boolean

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

HandleTabKeyNoMask()

Handles the tab key when no mask.

Declaration
protected virtual bool HandleTabKeyNoMask()
Returns
System.Boolean

HandleUnknownKeyOverride(Int32)

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

Declaration
protected virtual bool HandleUnknownKeyOverride(int keyCode)
Parameters
System.Int32 keyCode

Key's key code.
Returns
System.Boolean

Returns true if the key should not be processed.

InsertCharNoMask(Char)

Inserts a new character when no mask.

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

IsCharValid(Char)

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

Declaration
protected virtual bool IsCharValid(char character)
Parameters
System.Char character

The character.
Returns
System.Boolean

IsMaskValidOverride()

Performs validation on the masked text.

Declaration
protected virtual MaskValidationResult IsMaskValidOverride()
Returns
MaskValidationResult

Returns validation result information.

IsPlaceholder(Char)

Checks whether a specific character is a placeholder.

Declaration
protected virtual bool IsPlaceholder(char character)
Parameters
System.Char character

The character to be checked.
Returns
System.Boolean

Returns true if the character is a placeholder.

IsPlaceholder(Int32)

Checks whether a specific index is a placeholder.

Declaration
protected virtual bool IsPlaceholder(int index)
Parameters
System.Int32 index

The index to be checked.
Returns
System.Boolean

Returns true if the string is a placeholder.

IsPlaceholder(String)

Checks whether a specific string is a placeholder.

Declaration
protected virtual bool IsPlaceholder(string value)
Parameters
System.String value

The string to be checked.
Returns
System.Boolean

Returns true if the string is a placeholder.

IsSeparator(Char)

Checks whether a specific character is a separator.

Declaration
protected virtual bool IsSeparator(char character)
Parameters
System.Char character

The character to be checked.
Returns
System.Boolean

Returns true if the character is a separator.

IsSeparator(Char, out Separator)

Checks whether a specific character is a separator.

Declaration
protected virtual bool IsSeparator(char character, out Separator separator)
Parameters
System.Char character

The character to be checked.
Separator separator

Returns the separator that the character represents.
Returns
System.Boolean

Returns true if the character is a separator.

IsSeparator(String)

Checks whether a specified string is a separator.

Declaration
protected virtual bool IsSeparator(string value)
Parameters
System.String value

The string to be checked.
Returns
System.Boolean

Returns true if the string is a separator.

IsSeparator(String, out Separator)

Checks whether a specified string is a separator.

Declaration
protected virtual bool IsSeparator(string value, out Separator separator)
Parameters
System.String value

The string to be checked.
Separator separator

Returns the separator that the string represents.
Returns
System.Boolean

Returns true if the character is a separator.

IsSeparatorNoMask(Char)

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

Declaration
protected virtual bool IsSeparatorNoMask(char character)
Parameters
System.Char character

Returns
System.Boolean

MoveCharactersInInsertBehavior(ref Int32, Char, Boolean)

Moves characters to the left in Currency and Numeric Input.

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

System.Char inputSymbol

System.Boolean forward

MoveCharactersInInsertBehaviorOverride(ref Int32, Char, Boolean)

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

Declaration
protected virtual void MoveCharactersInInsertBehaviorOverride(ref int position, char character, bool forward)
Parameters
System.Int32 position

The position from which the move has to be done.
System.Char character

The character input at this position.
System.Boolean forward

The direction of the moving.
Remarks

The method expects the text after the move to the set to the internal TextBox.

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Creates automation peer.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

Returns the automation peer.

OnCultureChanged()

Executed when the Culture changes.

Declaration
protected virtual void OnCultureChanged()

OnLoadedOverride(Object, RoutedEventArgs)

Called when control is loaded.

Declaration
protected virtual 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.

OnMouseEnter(MouseEventArgs)

When the mouse enters the control.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

Mouse event args.

OnMouseLeave(MouseEventArgs)

When the mouse leaves the control.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

Mouse event args.

OnMouseWheel(MouseWheelEventArgs)

Handles the MouseWheel.

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

Event args of the MouseWheel.

OnSelectionOnFocus(SelectionOnFocus)

Executes when the focus is obtained.

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

The selection on focus.
Returns
System.Int32

Returns the selection start to be set when the focus is obtained.

OnUnloadedOverride(Object, RoutedEventArgs)

Called when the control is unloaded.

Declaration
protected virtual void OnUnloadedOverride(object sender, RoutedEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.RoutedEventArgs e

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

OnValueChangedBase(DependencyObject, DependencyPropertyChangedEventArgs, Boolean)

Executed when the Value property changes.

Declaration
protected static void OnValueChangedBase(DependencyObject d, DependencyPropertyChangedEventArgs args, bool processValueChanged)
Parameters
System.Windows.DependencyObject d

The owner of the value.
System.Windows.DependencyPropertyChangedEventArgs args

The changed args.
System.Boolean processValueChanged

True is ProcessValueChanged should be called.

ParseMask()

Parses the Mask property and sets the MaskedText.

Declaration
protected abstract string ParseMask()
Returns
System.String

Returns the parsed Mask.

ProcessChar(Char)

Process the input when a key has been pressed.

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

Remove(Int32, Int32, Boolean)

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

Declaration
protected virtual void Remove(int start, int length, bool checkPositions = true)
Parameters
System.Int32 start

The starting index.
System.Int32 length

The length.
System.Boolean checkPositions

True, if validation check should be performed on the removed positions.

ReplaceChar(StringBuilder, ref Int32)

Replaces a char when no mask.

Declaration
protected virtual void ReplaceChar(StringBuilder text, ref int position)
Parameters
System.Text.StringBuilder text

The text builder.
System.Int32 position

The position of the char.

ReplacePositionWithPlaceholder(Int32, Boolean, Boolean)

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

Declaration
protected virtual void ReplacePositionWithPlaceholder(int position, bool useSnapshot, bool forward)
Parameters
System.Int32 position

System.Boolean useSnapshot

System.Boolean forward

SelectAll()

Selects the whole text.

Declaration
public void SelectAll()

SetFromRightOffset(Int32)

Sets the offset from the right.

Declaration
protected virtual void SetFromRightOffset(int offset)
Parameters
System.Int32 offset

SetSeparators(Separator[])

Method that sets predefined separators.

Declaration
protected virtual void SetSeparators(params Separator[] separatorsArray)
Parameters
Separator[] separatorsArray

Array of separators to be set.

StartsWithSeparator(StringBuilder, Boolean, out Separator)

Checks whether a specified string starts with a separator.

Declaration
protected virtual bool StartsWithSeparator(StringBuilder text, bool forward, out Separator separator)
Parameters
System.Text.StringBuilder text

The string builder to search in.
System.Boolean forward

Direction of the search - true for forward, false for backward.
Separator separator

The found separator.
Returns
System.Boolean

Returns true if the string starts with a separator.

StartsWithSeparator(StringBuilder, Boolean, out Separator, ref Int32)

Checks whether a specified string starts with a separator.

Declaration
protected virtual bool StartsWithSeparator(StringBuilder text, bool forward, out Separator separator, ref int offset)
Parameters
System.Text.StringBuilder text

The string builder to search in.
System.Boolean forward

Direction of the search - true for forward, false for backward.
Separator separator

The found separator.
System.Int32 offset

The offset that the search begins from.
Returns
System.Boolean

Returns true if the string starts with a separator.

TrimTextStart(String, Char[])

Trims a specified string from certain characters.

Declaration
protected static string TrimTextStart(string text, params char[] trimCharacters)
Parameters
System.String text

The text to be trimmed.
System.Char[] trimCharacters

The characters to be trimmed from the text.
Returns
System.String

Returns the trimmed text.

UpdateEditableTextEndPositions()

Forces updates of the EditableTextEnd and EditableTextStart properties.

Declaration
protected void UpdateEditableTextEndPositions()

UpdateEditableTextEndPositionsOverride(ref Int32, ref Int32)

Updates the EditableTextEnd and EditableTextStart properties.

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

System.Int32 end

ValueChangingOverride(RoutedEventArgs)

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

Declaration
protected abstract 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.
Remarks

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

Events

ValueChanged

Occurs when the value is changed.

Declaration
public event EventHandler<RadRoutedEventArgs> ValueChanged
Event Type
System.EventHandler<RadRoutedEventArgs>

ValueChanging

Occurs before the value is changed.

Declaration
public event EventHandler<RadMaskedInputValueChangingEventArgs> ValueChanging
Event Type
System.EventHandler<RadMaskedInputValueChangingEventArgs>

Extension Methods