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

[Themable]
public abstract class RadMaskedInputBase : Control, IThemable

Constructors

RadMaskedInputBase()

Initializes a new instance of the RadMaskedInputBase class.

Declaration

protected RadMaskedInputBase()

Fields

IsLastPositionEditableProperty

Identifies the IsLastPositionEditable dependency property.

Declaration

public static readonly DependencyProperty IsLastPositionEditableProperty

Field Value

System.Windows.DependencyProperty

SectionsNavigationModeProperty

Identifies the SectionsNavigationMode dependency property.

Declaration

public static readonly DependencyProperty SectionsNavigationModeProperty

Field Value

System.Windows.DependencyProperty

Properties

Culture

Gets or sets the Culture.

Declaration

public CultureInfo Culture { get; set; }

Property Value

System.Globalization.CultureInfo

Remarks

Default culture is "en-US".

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.

EscapedPositions

Contains the escaped positions of the MaskedText.

Declaration

protected List<int> EscapedPositions { get; set; }

Property Value

System.Collections.Generic.List<System.Int32>

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.

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.

LiteralPositions

Contains the literal positions of the MaskedText.

Declaration

protected List<int> LiteralPositions { get; set; }

Property Value

System.Collections.Generic.List<System.Int32>

SectionsNavigationMode

Gets or sets the sections navigation mode.

Declaration

public SectionsNavigationMode SectionsNavigationMode { get; set; }

Property Value

SectionsNavigationMode

The sections navigation mode.

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.

Separators

Contains the Separators of the Mask.

Declaration

protected List<Separator> Separators { get; set; }

Property Value

System.Collections.Generic.List<Separator>

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.

Methods

CallSpin(Boolean)

Spins the control.

Declaration

public void CallSpin(bool isUp)

Parameters

System.Boolean isUp

True for spinning up, false for down.

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()

CoerceImeInputString(String)

Initial process of the text receives from the IME input.

Declaration

protected virtual string CoerceImeInputString(string text)

Parameters

System.String text

The initial text received from the IME.

Returns

System.String

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

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.

HandleSubstractKey()

Handles the Subtract key.

Declaration

protected virtual bool HandleSubstractKey()

Returns

System.Boolean

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

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.

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.

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.

OnApplicationCut(Object, ExecutedRoutedEventArgs)

Handles ApplicationCommand.Cut execution.

Declaration

protected void OnApplicationCut(object sender, ExecutedRoutedEventArgs e)

Parameters

System.Object sender

System.Windows.Input.ExecutedRoutedEventArgs e

OnApplicationPaste(Object, ExecutedRoutedEventArgs)

Handles ApplicationCommand.Paste execution.

Declaration

protected void OnApplicationPaste(object sender, ExecutedRoutedEventArgs e)

Parameters

System.Object sender

System.Windows.Input.ExecutedRoutedEventArgs e

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.

OnPreviewKeyDown(KeyEventArgs)

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

System.Windows.Input.KeyEventArgs e

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

ResetTheme()

Resets the theme.

Declaration

public void ResetTheme()

SelectAll()

Selects the whole text.

Declaration

public void SelectAll()

SetDefaultStyleKey()

Declaration

protected virtual void SetDefaultStyleKey()

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

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)