Class CurrencyTextBox

Extends the System.Windows.Forms.TextBox class to handle currency input and validation.

Inheritance
System.Object
TextBoxExt
NumberTextBoxBase
CurrencyTextBox
GridCurrencyTextBox
Implements
System.ComponentModel.ISupportInitialize
System.Runtime.Serialization.ISerializable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class CurrencyTextBox : NumberTextBoxBase, IThemeProvider, ISupportInitialize, ISerializable, IVisualStyle
Remarks

The CurrencyTextBox is derived from the textbox and provides all the functionality of a text box and adds additional functionality of its own.

Collecting currency input in a consistent format requires a lot of validation code that needs to be built into the application when using the Windows Forms textbox control. The CurrencyTextBox includes all this logic into its methods and properties and makes it easy for the developer and the end user to collect and enter currency data.

The CurrencyTextBox is also closely tied to the globalization settings of the operating system for Currency related properties. Please refer to the System.Globalization.NumberFormatInfo class for a detailed explanation of globalization and Currency related attributes.

The CurrencyTextBox has full support for the Windows Forms designer and you can just drag-and-drop and set properties on the control just as you would with the Windows Forms textbox.

The CurrencyTextBox also raises a ValidationError event when inappropriate data is entered into the control.

All clipboard functions such as copy, paste and cut are also supported with special accommodations for currency related issues.

Examples
   // Create the Calculator Control.
   this.currencyTextBox1 = new CurrencyTextBox();

   // Set the initial value.
   this.currencyTextBox1.Text = "$1.00";

   // Set the clipmode.
   this.currencyTextBox1.ClipMode = CurrencyClipModes.IncludeFormatting;

   // Set formatting properties.
   this.currencyTextBox1.CurrencyDecimalDigits = 2;
   this.currencyTextBox1.CurrencyDecimalSeparator = ".";
   this.currencyTextBox1.CurrencyGroupSeparator = ",";
   this.currencyTextBox1.CurrencyGroupSizes = new int[] {3};
   this.currencyTextBox1.CurrencyNegativePattern = 1;
   this.currencyTextBox1.CurrencyNumberDigits = 27;
   this.currencyTextBox1.CurrencyPositivePattern = 0;
   this.currencyTextBox1.CurrencySymbol = "$";
   this.currencyTextBox1.ForeColor = System.Drawing.Color.Black;
   this.currencyTextBox1.NegativeColor = System.Drawing.Color.Red;
   this.currencyTextBox1.NegativeSign = "-";
   this.currencyTextBox1.PositiveColor = System.Drawing.Color.Black;

   this.currencyTextBox1.Size = new System.Drawing.Size(256, 20);
   this.currencyTextBox1.TextAlign = System.Windows.Forms.HorizontalAlignment.Right;

   // Add the CurrencyTextBox control to the form.
   this.Controls.Add(this.currencyTextBox1);

Constructors

CurrencyTextBox()

Overloaded. Creates an object of type CurrencyTextBox.

Declaration
public CurrencyTextBox()
Remarks

The CurrencyTextBox object will be initialized with the default values for the display and data properties. You need to set any specific values.

Fields

MaxNumberLength

The maximum number of valid digits the textbox can take. This is set to the maximum value a decimal type can hold.

Declaration
public static int MaxNumberLength
Field Value
Type
System.Int32

Properties

AccessibilityEnabled

Gets or sets a value indicating whether the control should enable its Accessibility support.

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

CurrencyDecimalDigits

The maximum number of digits for the decimal portion of the currency.

Declaration
public int CurrencyDecimalDigits { get; set; }
Property Value
Type
System.Int32
Remarks

The US dollar requires 2 decimal points to accomodate the smallest denomination and this property will have the value 2 in this case. If there is a need to have a different value based on the locale, it will be automatically changed based on the current locale.

CurrencyDecimalSeparator

The decimal separator character that will be used for the display.

Declaration
public string CurrencyDecimalSeparator { get; set; }
Property Value
Type
System.String
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

CurrencyGroupSeparator

This property specifies the separator to be used for grouping digits.

Declaration
public string CurrencyGroupSeparator { get; set; }
Property Value
Type
System.String
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

CurrencyGroupSizes

This property specifies the grouping of CurrencyDigits in the CurrencyTextBox.

Declaration
public int[] CurrencyGroupSizes { get; set; }
Property Value
Type
System.Int32[]
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

CurrencyNegativePattern

This property specifies the pattern to use when the value is negative.

Declaration
public int CurrencyNegativePattern { get; set; }
Property Value
Type
System.Int32
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

CurrencyNegativePatterns

Declaration
protected string[] CurrencyNegativePatterns { get; set; }
Property Value
Type
System.String[]

CurrencyNumberDigits

The number of digits for the number part. This is not part of the globalization structure.

Declaration
public int CurrencyNumberDigits { get; set; }
Property Value
Type
System.Int32
Remarks

This value is initially set based on the maximum value of the Currency data type.

CurrencyPositivePattern

This property specifies the pattern to use when the value is positive.

Declaration
public int CurrencyPositivePattern { get; set; }
Property Value
Type
System.Int32
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

CurrencySymbol

This property specifies the currency symbol to be used in the CurrencyTextBox.

Declaration
public string CurrencySymbol { get; set; }
Property Value
Type
System.String
Remarks

This value is initially set from the System.Globalization.NumberFormatInfo and can be changed based on your requirements or based on the locale.

DecimalValue

The decimal value of the control. This will be formatted and displayed.

Declaration
public decimal DecimalValue { get; set; }
Property Value
Type
System.Decimal

MaxValue

The Maximum Value that can be set through the CurrencyTextBox.

Declaration
public decimal MaxValue { get; set; }
Property Value
Type
System.Decimal
Remarks

The default value is the MaxValue for System.Decimal.

MinValue

The Minimum Value that can be set through the CurrencyTextBox.

Declaration
public decimal MinValue { get; set; }
Property Value
Type
System.Decimal

NumberDigits

The number of digits for the number part. This is not part of the globalization structure.

Declaration
public int NumberDigits { get; set; }
Property Value
Type
System.Int32
Remarks

This value is initially set based on the maximum value of the Currency data type.

RemoveDecimalZeros

Gets or sets remove last decimal zeros.

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

Text

Overrides the Text property of System.Windows.Forms.TextBox.

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

This property is overriden in order to normalize the data that is set to the Text property and format it as needed. The method InsertString(String, Int32, Int32, String, Boolean) is used to format the data.

ThemeStyle

Declaration
public CurrencyTextBoxVisualStyle ThemeStyle { get; set; }
Property Value
Type
CurrencyTextBoxVisualStyle

Methods

ApplyFormatting(String)

Format the given text according to the current setting.

Declaration
protected override string ApplyFormatting(string rawValue)
Parameters
Type Name Description
System.String rawValue
Returns
Type
System.String
Overrides

CanInsert(String, String, Int32)

Checks if the text can be inserted subject to the constraints.

Declaration
protected override int CanInsert(string currentText, string inputText, int initialZeroCount)
Parameters
Type Name Description
System.String currentText

The current content of the TextBox.
System.String inputText

The text to be inserted.
System.Int32 initialZeroCount
Returns
Type Description
System.Int32

The length of the acceptable string to be inserted.
Overrides

CheckForMinMax(Decimal)

Declaration
protected bool CheckForMinMax(decimal numericValue)
Parameters
Type Name Description
System.Decimal numericValue
Returns
Type
System.Boolean

CheckForMinMax(String, Boolean)

Declaration
protected override bool CheckForMinMax(string currentTextValue, bool ignoreLength)
Parameters
Type Name Description
System.String currentTextValue
System.Boolean ignoreLength
Returns
Type
System.Boolean
Overrides

CheckIfNegative(String)

Declaration
protected override bool CheckIfNegative(string rawValue)
Parameters
Type Name Description
System.String rawValue
Returns
Type
System.Boolean
Overrides

CheckIsZero()

Checks whether the value is zero.

Declaration
protected override bool CheckIsZero()
Returns
Type Description
System.Boolean

True, if value is zero.
Overrides

ConcatModifiedText(String, String, String)

Declaration
protected override string ConcatModifiedText(string startCurrentText, string inputRawText, string endCurrentText)
Parameters
Type Name Description
System.String startCurrentText
System.String inputRawText
System.String endCurrentText
Returns
Type
System.String
Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type
System.Windows.Forms.AccessibleObject
Overrides

CurrencyFormattedText(NumberFormatInfo, String, String, out Decimal)

Gets the currency formatted text and the decimal value for a given NumberFormatInfo object and text value.

Declaration
public static string CurrencyFormattedText(NumberFormatInfo nfi, string currencyText, string nullString, out decimal dValue)
Parameters
Type Name Description
System.Globalization.NumberFormatInfo nfi

The NumberFormatFormatInfo object to be used for the formatting.
System.String currencyText

The text to be formatted.
System.String nullString

The value to be returned if the currencyText is considered a NULL value. This should be NULL if the string is not to be formatted as NULL even if value is NULL.
System.Decimal dValue

The decimal value.
Returns
Type
System.String

Dispose(Boolean)

Releases the unmanaged resources used by the CurrencyTextBox and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanage resources.
Overrides

FormatChanged(String, NumberFormatInfo)

Declaration
protected override void FormatChanged(string currentText, NumberFormatInfo previousFormat)
Parameters
Type Name Description
System.String currentText
System.Globalization.NumberFormatInfo previousFormat
Overrides

GetControlName(String)

Helps to override the ThemeName property settings

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

ThemeName
Returns
Type
System.String
Overrides

GetDecimalDigits()

Declaration
protected override int GetDecimalDigits()
Returns
Type
System.Int32
Overrides

GetDecimalSeparator(NumberFormatInfo)

Override this to return CurrencyDecimalSeparator in CurrencyTextBox and PercentDecimalSeparator in PercentTextBox.

Declaration
protected override string GetDecimalSeparator(NumberFormatInfo info)
Parameters
Type Name Description
System.Globalization.NumberFormatInfo info
Returns
Type
System.String
Overrides

GetDecimalSeparatorPosition(String)

Returns the position of the decimal separator taking into account the CurrencySymbol.

Declaration
protected override int GetDecimalSeparatorPosition(string currentText)
Parameters
Type Name Description
System.String currentText

The text in which to look for the decimal separator.
Returns
Type Description
System.Int32

The decimal separator's position.
Overrides

GetGroupSeparator(NumberFormatInfo)

Override this to return CurrencyDecimalSeparator in CurrencyTextBox and PercentGroupSeparator in PercentTextBox.

Declaration
protected override string GetGroupSeparator(NumberFormatInfo info)
Parameters
Type Name Description
System.Globalization.NumberFormatInfo info
Returns
Type
System.String
Overrides

GetNumberPartLength(Decimal)

Declaration
protected int GetNumberPartLength(decimal numberValue)
Parameters
Type Name Description
System.Decimal numberValue
Returns
Type
System.Int32

GetNumberValue(String, Int32)

Declaration
protected override string GetNumberValue(string formattedText, int startPosition)
Parameters
Type Name Description
System.String formattedText
System.Int32 startPosition
Returns
Type
System.String
Overrides

GetStartPositionJustNumbers(String, Int32)

Declaration
protected override int GetStartPositionJustNumbers(string formattedText, int startPosition)
Parameters
Type Name Description
System.String formattedText
System.Int32 startPosition
Returns
Type
System.Int32
Overrides

GetValue()

Declaration
protected override object GetValue()
Returns
Type
System.Object
Overrides

HandleBackspaceKey()

Declaration
protected override bool HandleBackspaceKey()
Returns
Type
System.Boolean
Overrides

HandleCharacterKey(Char)

Declaration
protected override bool HandleCharacterKey(char charToBeInserted)
Parameters
Type Name Description
System.Char charToBeInserted
Returns
Type
System.Boolean
Overrides

HandleDecimalKey()

Declaration
protected override bool HandleDecimalKey()
Returns
Type
System.Boolean
Overrides

HandleDeleteKey()

Declaration
protected override bool HandleDeleteKey()
Returns
Type
System.Boolean
Overrides

InitializeNumberTextBox()

Overrides InitializeNumberTextBox().

Declaration
protected override void InitializeNumberTextBox()
Overrides

IsAssignable(Object)

Declaration
protected override bool IsAssignable(object val)
Parameters
Type Name Description
System.Object val
Returns
Type
System.Boolean
Overrides

IsDataPosition(String, Int32)

Declaration
protected override bool IsDataPosition(string formattedText, int position)
Parameters
Type Name Description
System.String formattedText
System.Int32 position
Returns
Type
System.Boolean
Overrides

IsInDecimalPosition(String, Int32)

Declaration
protected override bool IsInDecimalPosition(string currentText, int startPosition)
Parameters
Type Name Description
System.String currentText
System.Int32 startPosition
Returns
Type
System.Boolean
Overrides

OnDecimalValueChanged(EventArgs)

Raises the DecimalValueChanged event.

Declaration
protected virtual void OnDecimalValueChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnEnabledChanged(EventArgs)

Raises the System.Windows.Forms.Control.EnabledChanged event.

Declaration
protected override void OnEnabledChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnEnter(EventArgs)

Overrides the System.Windows.Forms.Control.OnEnter(System.EventArgs) method.

Declaration
protected override void OnEnter(EventArgs args)
Parameters
Type Name Description
System.EventArgs args

The event data.
Overrides
Remarks

Saves the current DecimalValue so that it can be compared during validation. The DecimalValueChanged and TextChanged event will only be raised if the value is different during validation.

OnGotFocus(EventArgs)

Helps to override the OnGotFocus events

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

OnTextChanged(EventArgs)

Overrides OnTextChanged.

Declaration
protected override void OnTextChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The event data.
Overrides

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

OnValidated(EventArgs)

Declaration
protected override void OnValidated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnValidating(CancelEventArgs)

Declaration
protected override void OnValidating(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

ParseForNegativeFormat(String, NumberFormatInfo)

Overrides ParseForNegativeFormat(String, NumberFormatInfo)

Declaration
protected override bool ParseForNegativeFormat(string currentText, NumberFormatInfo info)
Parameters
Type Name Description
System.String currentText

The text to be parsed.
System.Globalization.NumberFormatInfo info
Returns
Type Description
System.Boolean

True if the value is negative; false, otherwise
Overrides

PositionCursorAfterEdit(Int32, Boolean, Boolean, Boolean)

Declaration
protected override void PositionCursorAfterEdit(int startPositionJustNumbers, bool inDecimalPosition, bool back, bool delete)
Parameters
Type Name Description
System.Int32 startPositionJustNumbers
System.Boolean inDecimalPosition
System.Boolean back
System.Boolean delete
Overrides

PrepareInsertString(String, Int32, Int32, String, Boolean)

Declaration
protected override NumberModifyState PrepareInsertString(string currentText, int startPosition, int selectionLength, string textToBeInserted, bool pasteOperation)
Parameters
Type Name Description
System.String currentText
System.Int32 startPosition
System.Int32 selectionLength
System.String textToBeInserted
System.Boolean pasteOperation
Returns
Type
NumberModifyState
Overrides

RemoveFormatting(String, NumberFormatInfo, Boolean)

Declaration
protected override string RemoveFormatting(string formattedText, NumberFormatInfo info, bool padIfEmpty)
Parameters
Type Name Description
System.String formattedText
System.Globalization.NumberFormatInfo info
System.Boolean padIfEmpty
Returns
Type
System.String
Overrides

ResetCurrencyDecimalDigits()

Reset the value to the culture specific value.

Declaration
protected void ResetCurrencyDecimalDigits()

ResetCurrencyDecimalSeparator()

Resets the value to the culture specific value.

Declaration
protected void ResetCurrencyDecimalSeparator()

ResetCurrencyGroupSeparator()

Resets the value to the culture specific value.

Declaration
protected void ResetCurrencyGroupSeparator()

ResetCurrencyGroupSizes()

Resets the value to the culture specific value.

Declaration
protected void ResetCurrencyGroupSizes()

ResetCurrencyNegativePattern()

Resets the value to the culture specific value.

Declaration
protected void ResetCurrencyNegativePattern()

ResetCurrencyNumberDigits()

Restores the CurrencyNumberDigits to the MaximumLength.

Declaration
protected void ResetCurrencyNumberDigits()

ResetCurrencyPositivePattern()

Resets the value to the culture specific value.

Declaration
protected void ResetCurrencyPositivePattern()

ResetCurrencySymbol()

Resets the value to the culture specific value

Declaration
protected void ResetCurrencySymbol()

ResetMaxValue()

Resets the value to the default.

Declaration
protected void ResetMaxValue()

ResetMinValue()

Resets the value to the default.

Declaration
protected void ResetMinValue()

ResetNumberDigits()

Restores the CurrencyNumberDigits to the MaximumLength.

Declaration
protected void ResetNumberDigits()

ResetText()

Restores the CurrencyNumberDigits to the MaximumLength.

Declaration
protected void ResetText()

SetDecimalValue(Decimal)

Declaration
protected void SetDecimalValue(decimal newValue)
Parameters
Type Name Description
System.Decimal newValue

SetNullNumberValue()

Declaration
protected override void SetNullNumberValue()
Overrides

SetTextProperty(String)

Declaration
protected override void SetTextProperty(string newText)
Parameters
Type Name Description
System.String newText
Overrides

SetValue(Object)

Declaration
protected override void SetValue(object val)
Parameters
Type Name Description
System.Object val
Overrides

ShouldSerializeCurrencyDecimalDigits()

Indicates whether the CurrencyDecimalDigits should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyDecimalDigits()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencyDecimalSeparator()

Indicates whether the CurrencyDecimalSeparator should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyDecimalSeparator()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencyGroupSeparator()

Indicates whether the CurrencyGroupSeparator should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyGroupSeparator()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencyGroupSizes()

Indicates whether the CurrencyGroupSizes should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyGroupSizes()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencyNegativePattern()

Indicates whether the CurrencyNegativePattern should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyNegativePattern()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencyNumberDigits()

Indicates whether to serialize the CurrencyNumberDigits property if its the same as the MaximumLength

Declaration
protected bool ShouldSerializeCurrencyNumberDigits()
Returns
Type
System.Boolean

ShouldSerializeCurrencyPositivePattern()

Indicates whether the CurrencyPositivePattern should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencyPositivePattern()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeCurrencySymbol()

Indicates whether the CurrencySymbol should not be serialized if the value is the same as the one for the current culture.

Declaration
protected bool ShouldSerializeCurrencySymbol()
Returns
Type Description
System.Boolean

True if the value is different from the value for the current culture.

ShouldSerializeMaxValue()

Indicates whether the MaxValue property should be serialized.

Declaration
protected bool ShouldSerializeMaxValue()
Returns
Type Description
System.Boolean

true if the value is not equal to System.Decimal.MaxValue

ShouldSerializeMinValue()

Indicates whether the MinValue property should be serialized.

Declaration
protected bool ShouldSerializeMinValue()
Returns
Type Description
System.Boolean

True if the value is not equal to System.Decimal.MaxValue

ShouldSerializeNumberDigits()

Indicates whether to serialize the CurrencyNumberDigits property if its the same as the MaximumLength.

Declaration
protected bool ShouldSerializeNumberDigits()
Returns
Type
System.Boolean

ShouldSerializeText()

Indicates whether to serialize the Text property if it is null or quals NullString

Declaration
protected bool ShouldSerializeText()
Returns
Type
System.Boolean

ToggleNegative(String)

Declaration
protected override string ToggleNegative(string currentText)
Parameters
Type Name Description
System.String currentText
Returns
Type
System.String
Overrides

Events

DecimalValueChanged

Occurs when the DecimalValue property is changed.

Declaration
public event EventHandler DecimalValueChanged
Event Type
Type
System.EventHandler

Implements

System.ComponentModel.ISupportInitialize
System.Runtime.Serialization.ISerializable