Export (0) Print
Expand All

Strings.FormatCurrency Method

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)

'Declaration
Public Shared Function FormatCurrency ( _
	Expression As Object, _
	NumDigitsAfterDecimal As Integer, _
	IncludeLeadingDigit As TriState, _
	UseParensForNegativeNumbers As TriState, _
	GroupDigits As TriState _
) As String
'Usage
Dim Expression As Object 
Dim NumDigitsAfterDecimal As Integer 
Dim IncludeLeadingDigit As TriState 
Dim UseParensForNegativeNumbers As TriState 
Dim GroupDigits As TriState 
Dim returnValue As String 

returnValue = Strings.FormatCurrency(Expression, _
	NumDigitsAfterDecimal, IncludeLeadingDigit, _
	UseParensForNegativeNumbers, GroupDigits)

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 "Settings" for values.

UseParensForNegativeNumbers
Type: Microsoft.VisualBasic.TriState

Optional. TriState enumeration that indicates whether or not to place negative values within parentheses. See "Settings" 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 "Settings" 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.

For more detailed information, see the Visual Basic topic FormatCurrency Function (Visual Basic).

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.

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)

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft