FormatCurrency Method

Strings.FormatCurrency Method (Object, Int32, TriState, TriState, TriState)

 

Returns an expression formatted as a currency value using the currency symbol defined in the system control panel.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static string FormatCurrency(
	object Expression,
	int NumDigitsAfterDecimal = -1,
	TriState IncludeLeadingDigit = TriState.UseDefault,
	TriState UseParensForNegativeNumbers = TriState.UseDefault,
	TriState GroupDigits = TriState.UseDefault
)

Parameters

Expression
Type: System.Object

Required. Expression to be formatted.

NumDigitsAfterDecimal
Type: System.Int32

Optional. Numeric value indicating how many places are displayed to the right of the decimal. Default value is –1, which indicates that the computer's regional settings are used.

IncludeLeadingDigit
Type: Microsoft.VisualBasic.TriState

Optional. TriState enumeration that indicates whether or not a leading zero is displayed for fractional values. See "Remarks" for values.

UseParensForNegativeNumbers
Type: Microsoft.VisualBasic.TriState

Optional. TriState enumeration that indicates whether or not to place negative values within parentheses. See "Remarks" for values.

GroupDigits
Type: Microsoft.VisualBasic.TriState

Optional. TriState enumeration that indicates whether or not numbers are grouped using the group delimiter specified in the computer's regional settings. See "Remarks" for values.

Return Value

Type: System.String

Returns an expression formatted as a currency value using the currency symbol defined in the system control panel.

Exception Condition
ArgumentException

Number of digits after decimal point is greater than 99.

InvalidCastException

Type is not numeric.

When one or more optional arguments are omitted, the computer's matching regional-settings values are used instead.

The position of the currency symbol relative to the currency value is determined by the system's regional settings.

System_CAPS_noteNote

All settings information comes from the locale of the application. By default, that will be the locale set in the control panel. However, it may be changed programmatically by using the .NET Framework, except leading zero, which comes from the Number tab.

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments take the following TriState enumeration values.

Value

Description

TriState.True

True

TriState.False

False

TriState.UseDefault

The computer's regional settings

The following example illustrates the use of the FormatCurrency function.

Dim TestDebt As Double = -4456.43
Dim TestString As String
' Returns "($4,456.43)".
TestString = FormatCurrency(TestDebt, , , TriState.True, TriState.True)

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show:
© 2016 Microsoft