Class RadMaskedCurrencyInput

Represents the RadMaskedCurrencyInput control.

Inheritance
System.Object
RadMaskedInputBase
RadMaskedCurrencyInput
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll

Syntax

[TelerikToolboxCategory("Input")]
[Themable]
public class RadMaskedCurrencyInput : RadMaskedInputBase, IThemable

Constructors

RadMaskedCurrencyInput()

Initializes a new instance of the RadMaskedCurrencyInput class.

Declaration
public RadMaskedCurrencyInput()

Fields

AllowSkipPlaceholdersProperty

Identifies the AllowSkipPlaceholders dependency property.

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

AutoFillNumberGroupSeparatorsProperty

Identifies the AutoFillNumberGroupSeparators dependency property.

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

AutoFillZerosProperty

Identifies the AutoFillZeros dependency property.

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

IsCurrencySymbolVisibleProperty

Identifies the IsCurrencySymbolVisible dependency property.

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

ValueProperty

Identifies the Value dependency property.

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

Properties

AllowSkipPlaceholders

Gets or sets whether input can skip placeholders.

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

AutoFillNumberGroupSeparators

Gets or sets whether number group separators are auto filled in the mask.

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

AutoFillZeros

Gets or sets whether trailing zeros should be auto filled.

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

CurrencySymbol

Gets or sets the currency symbol according to the set culture.

Declaration
protected Separator CurrencySymbol { get; set; }
Property Value
Separator

DecimalSeparator

The Decimal separator for the current culture.

Declaration
protected Separator DecimalSeparator { get; set; }
Property Value
Separator

InputBehaviorResolved

Gets or sets the resolved InputBehavior.

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

Overrides

IsCurrencySymbolVisible

Gets or sets whether the currency symbol is visible.

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

IsNegativeValue

Gets or sets whether the number is negative. IsNegative returns True for negative nulls too. In no-masked scenarios, "()", "-" are treated as negative nulls.

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

IsPercentageValue

Gets or sets whether the number is percentage.

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

NegativeSign

The Negative symbol for the current culture.

Declaration
protected Separator NegativeSign { get; set; }
Property Value
Separator

NumberSeparator

The Number separator for the current culture.

Declaration
protected Separator NumberSeparator { get; set; }
Property Value
Separator

PercentageSign

The Percentage symbol.

Declaration
protected Separator PercentageSign { get; set; }
Property Value
Separator

Precision

The precision of the value.

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

Value

Gets or sets the Value property.

Declaration
public decimal? Value { get; set; }
Property Value
System.Nullable<System.Decimal>

Methods

CanModifyChar(Char)

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

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

Returns
System.Boolean

Overrides

CanReplaceChar(Char)

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

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

Returns
System.Boolean

Overrides

ClearSelectionNoMask()

Clears the selection when no mask.

Declaration
protected override void ClearSelectionNoMask()
Overrides

CoerceDisplayTextOverride()

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

Declaration
protected override string CoerceDisplayTextOverride()
Returns
System.String

Returns the display text.
Overrides

CoerceInternalValueFromStronglyTypeValueOverride()

Coerces the ValueInternal property from the Value property.

Declaration
protected override void CoerceInternalValueFromStronglyTypeValueOverride()
Overrides

CoerceStronglyTypeValueFromInternalValueOverride()

Coerces the Value property from the ValueInternal property.

Declaration
protected override void CoerceStronglyTypeValueFromInternalValueOverride()
Overrides

CoerceTextInternalOverride(ref Int32)

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

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

The selection start.
Returns
System.String

The coerced text.
Overrides

CoerceTextOverride(ref Int32)

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

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

The selection start.
Returns
System.String

Returns the string to be coerced.
Overrides

CoerceValueOverride()

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

Declaration
protected override bool CoerceValueOverride()
Returns
System.Boolean

Returns true if the value can be coerced.
Overrides

GetDecimalSeparatorIndex(String)

Gets the index of the decimal separator from a specific text.

Declaration
protected int GetDecimalSeparatorIndex(string text)
Parameters
System.String text

The text to search in.
Returns
System.Int32

Returns the index of the Decimal separator.

GetRightOffset()

Gets the offset from the right.

Declaration
protected override int GetRightOffset()
Returns
System.Int32

Overrides

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

Gets the valid char for a position.

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

The character to be validated.
System.Int32 position

Position in the MaskedText to validate.
System.Nullable<System.Boolean> forwardSpin

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

True if the character is valid for this position.
Returns
System.String

Returns the result valid character for the specified position.
Overrides

GetValueRankFromIndex(Int32)

Gets the rank of a number in the TextBox in respect to the caret.

Declaration
protected int GetValueRankFromIndex(int index)
Parameters
System.Int32 index

The index of the caret.
Returns
System.Int32

Returns the rank.

HandleBackKeyNoMask()

Handles the Back key when no mask.

Declaration
protected override void HandleBackKeyNoMask()
Overrides

HandleClearOverride()

Called, when the Clear command is invoked.

Declaration
protected override void HandleClearOverride()
Overrides

HandleDivideKey()

Handles the Divide key.

Declaration
protected override bool HandleDivideKey()
Returns
System.Boolean

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

HandleLeftKey()

Handles the left key down.

Declaration
protected override void HandleLeftKey()
Overrides

HandleMultiplyKey()

Handles the Multiply key.

Declaration
protected override bool HandleMultiplyKey()
Returns
System.Boolean

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

HandlePasteNoMask(Object, out Object)

Handles paste operation in no-mask scenarios.

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

System.Object returnString

Returns
System.Boolean

Overrides

HandlePasteOverride(Object, out Object)

Handles the paste operation.

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

The value to be pasted.
System.Object returnString

Returns the string representation of the value.
Returns
System.Boolean

Returns true if the value can be pasted.
Overrides

HandleSpin(Int32, Nullable<Boolean>)

Handle the spin of the value.

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

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

Direction of spin.
Overrides

HandleSpinNoMask(Boolean)

Handles the spin when no mask.

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

Overrides

HandleSubstractKey()

Handles the Subtract key.

Declaration
protected override bool HandleSubstractKey()
Returns
System.Boolean

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

HandleUnknownKeyOverride(Int32)

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

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

Key's key code.
Returns
System.Boolean

Returns true if the key should not be processed.
Overrides

InsertCharNoMask(Char)

Inserts a new character when no mask.

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

Overrides

InsertSeparatorsOverride(String)

Inserts number group separators in the mask.

Declaration
protected string InsertSeparatorsOverride(string mask)
Parameters
System.String mask

The mask text.
Returns
System.String

Returns the modified string.

IsCharValid(Char)

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

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

The character.
Returns
System.Boolean

Overrides

IsSeparator(Char)

Checks whether a character is a separator or not.

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

The character to be checked.
Returns
System.Boolean

Returns true if the character is or is part of separator.
Overrides
Remarks

This method will also check if the character is part of the currency symbol.

IsSeparatorNoMask(Char)

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

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

Returns
System.Boolean

Overrides

MoveCharactersInInsertBehaviorOverride(ref Int32, Char, Boolean)

Moves a group characters from the specified position to the left one position from the last Placeholder.

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

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

OnCultureChanged()

Executed when the Culture changes.

Declaration
protected override void OnCultureChanged()
Overrides

OnInitialized(EventArgs)

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

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

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

OnSelectionOnFocus(SelectionOnFocus)

Executes when the focus is obtained.

Declaration
protected override 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.
Overrides

ParseMask()

Parses the Mask property and sets the MaskedText.

Declaration
protected override string ParseMask()
Returns
System.String

Returns the parsed Mask.
Overrides

ReplaceChar(StringBuilder, ref Int32)

Replaces a char when no mask.

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

The text builder.
System.Int32 position

The position of the char.
Overrides

SetFromRightOffset(Int32)

Sets the offset from the right.

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

Overrides

ToggleNegativeSignKey()

Toggles the visibility of the Negative symbol.

Declaration
protected void ToggleNegativeSignKey()

ValueChangingOverride(RoutedEventArgs)

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

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

Returns
System.Boolean

Returns a boolean flag whether the value change has to be handled or not.
Overrides
Remarks

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

Extension Methods