SetNumberFormat Method (TextField)

In This Topic

Imposes the specified numeric formatting options on the current TextField.

Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub SetNumberFormat( _
   ByVal decimalPlaces As System.Integer, _
   ByVal separatorStyle As Field.NumberSeparatorStyle, _
   ByVal negativeStyle As Field.NumberNegativeStyle, _
   ByVal currencySymbol As System.String, _
   ByVal currencySymbolStyle As Field.CurrencySymbolStyle _
)

public void SetNumberFormat( 
   System.int decimalPlaces,
   Field.NumberSeparatorStyle separatorStyle,
   Field.NumberNegativeStyle negativeStyle,
   System.string currencySymbol,
   Field.CurrencySymbolStyle currencySymbolStyle
)

Parameters

decimalPlaces: The number of digits that appear to the right of the decimal point. Valid values are from 0 to 10, inclusive.
separatorStyle: The placement of commas and periods, see Field.NumberSeparatorStyle.
negativeStyle: How negative numbers are displayed.
currencySymbol: The currency symbol, or a null reference (Nothing in Visual Basic) or empty string.
currencySymbolStyle: The location of the currency symbol in relation to the number. This parameter is meaningful only if currencySymbol is not a null reference (Nothing in Visual Basic) or empty.

Reference

TextField Class
TextField Members