Restriction or Validation in WPF Currency TextBox

6 Jul 20216 minutes to read

This section explains how to validate or restrict the CurrencyTextBox control value.

Restrict the value within minimum and maximum value

The Value of the CurrencyTextBox can be restricted within the maximum and minimum limits. Once the value has reached the maximum or minimum value , the value does not exceed the limit. We can change the maximum and minimum limits by using the MinValue property and MaxValue property.

You can choose when to validate the maximum and minimum limits while changing the values by using the MinValidation and MaxValidation properties.

• OnKeyPress — When setting the MaxValidation or MinValidation to OnKeyPress, the value in the CurrencyTextBox will be validated shortly after pressing a key. So, it is not possible to provide any invalid input at all and the value does not exceed the maximum and minimum limits.

• OnLostFocus - When setting MaxValidation or MinValidation to OnLostFocus, the value in the CurrencyTextBox is validated, when the CurrencyTextBox loses the focus. That is, the CurrencyTextBox will accept any value, validation will only take place after the CurrencyTextBox has lost its keyboard focus. After validation, when the value of the CurrencyTextBox is greater than the MaxValue or less than the MinValue, the value will be automatically set to MaxValue or MinValue.

• MaxValueOnExceedMaxDigit - When you give input greater than specified maximum limit, MaxValueOnExceedMaxDigit property will decide either it should retain the old value or reset to maximum limit that is specified. For example, if MaxValue is set to 100 and you are trying to input 200. Value will changed to 100 when MaxValueOnExceedMaxDigit is true. When MaxValueOnExceedMaxDigit is false, 20 will be retained and last entered 0 will be ignored.

  NOTE

  MaxValueOnExceedMinDigit property will be enabled only when the MaxValidation is set to OnKeyPress.

• MinValueOnExceedMinDigit - When you give input less than specified minimum limit, MinValueOnExceedMinDigit property will decide either it should retain the old value or reset to minimum limit that is specified. For example, if MinValue is set to 200 and the Value is 205 and you are trying change the value to 20. Value will changed to 200 when MinValueOnExceedMinDigit is true. When MinValueOnExceedMinDigit is false, Old value 205 will be retained.

  NOTE

  MinValueOnExceedMinDigit will be enabled only when the MinValidation is set to OnKeyPress.

XAML

<syncfusion:CurrencyTextBox x:Name="currencyTextBox" Width="150" MaxValue="100" MinValue="10"
                          MinValueOnExceedMinDigit="True" MaxValueOnExceedMaxDigit="True"
                          MinValidation="OnKeyPress" MaxValidation="OnLostFocus"/>

C#

CurrencyTextBox currencyTextBox = new CurrencyTextBox();
currencyTextBox.Width = 150;
currencyTextBox.Height = 25;
currencyTextBox.MinValue = 10;
currencyTextBox.MaxValue =100;
currencyTextBox.MinValidation = MinValidation.OnKeyPress;
currencyTextBox.MaxValidation = MaxValidation.OnLostFocus;
currencyTextBox.MinValueOnExceedMinDigit = true;
currencyTextBox.MaxValueOnExceedMaxDigit = true;

MinValidation is set to OnKeyPress, it cannot let to enter a value less than the MinValue. If try to enter a value less than the MinValue, then the MinValue will set to the Value property because MinValueOnExceedMinDigit is set to true.

MaxValidation is set to OnLostFocus, so the MaxValidation will be performed only in the lost focus.

Restrict number of decimal digits

You can format the decimal digits in the CurrencyTextBox control using CurrencyDecimalDigits property. You can also restrict the decimal digits of the text within minimum and maximum limit in CurrencyTextBox control using MinimumCurrencyDecimalDigits and MaximumCurrencyDecimalDigits properties. The default value of MinimumCurrencyDecimalDigits,MaximumCurrencyDecimalDigits and CurrencyDecimalDigits properties is -1.

NOTE

If the value of MinimumCurrencyDecimalDigits property is greater than the value of MaximumCurrencyDecimalDigits property, the text of CurrencyTextBox will be updated based on value of MinimumCurrencyDecimalDigits property.

XAML

<syncfusion:CurrencyTextBox Value="125.32545" HorizontalAlignment="Center" VerticalAlignment="Center"
                            MaximumCurrencyDecimalDigits="4"
                            MinimumCurrencyDecimalDigits="1" />

C#

CurrencyTextBox currencyTextBox = new CurrencyTextBox();
currencyTextBox.Value = 125.32545;
currencyTextBox.MaximumCurrencyDecimalDigits = 4;
currencyTextBox.MinimumCurrencyDecimalDigits = 1;

When the value of MinimumCurrencyDecimalDigits, MaximumCurrencyDecimalDigits and CurrencyDecimalDigits properties are specified, CurrencyDecimalDigits property takes high precedence and updates the text of CurrencyTextBox property.

XAML

<syncfusion:CurrencyTextBox Value="125.32545" HorizontalAlignment="Center" VerticalAlignment="Center"
                            MaximumCurrencyDecimalDigits="4"
                            MinimumCurrencyDecimalDigits="1" 
                            CurrencyDecimalDigits="3"
                            />

C#

CurrencyTextBox currencyTextBox = new CurrencyTextBox();
currencyTextBox.Value = 125.32545;
currencyTextBox.MaximumCurrencyDecimalDigits = 4;
currencyTextBox.MinimumCurrencyDecimalDigits = 1;
currencyTextBox.CurrencyDecimalDigits = 3;

Read only mode

The CurrencyTextBox cannot allow the user input, edits when IsReadOnly property is sets to true. The user can still select text and display the cursor on the CurrencyTextBox by setting the IsReadOnlyCaretVisible property to true. However, value can be changed programmatically in readonly mode.

XAML

<syncfusion:CurrencyTextBox x:Name="currencyTextBox" IsReadOnly="True" Value="10" IsReadOnlyCaretVisible="True"/>

C#

CurrencyTextBox currencyTextBox = new CurrencyTextBox();
currencyTextBox.Value = 10;
currencyTextBox.IsReadOnly = true;
currencyTextBox.IsReadOnlyCaretVisible = true;