Export (0) Print
Expand All

Strings.FormatNumber Method

Returns an expression formatted as a number.

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

'Declaration
Public Shared Function FormatNumber ( _
	Expression As Object, _
	NumDigitsAfterDecimal As Integer, _
	IncludeLeadingDigit As TriState, _
	UseParensForNegativeNumbers As TriState, _
	GroupDigits As TriState _
) As String

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. The default value is –1, which indicates that the computer's regional settings are used.
IncludeLeadingDigit
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether a leading 0 is displayed for fractional values. See "Settings" for values.
UseParensForNegativeNumbers
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether to place negative values within parentheses. See "Settings" for values.
GroupDigits
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether or not numbers are grouped using the group delimiter specified in the locale settings. See "Settings" for values.

Return Value

Type: System.String
Returns an expression formatted as a number.

ExceptionCondition
InvalidCastException

Type is not numeric.

When one or more optional arguments are omitted the values for omitted arguments are provided by the locale 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.

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings.

Constant

Description

TriState.True

True

TriState.False

False

TriState.UseDefault

The computer's regional settings

This example demonstrates the FormatNumber function.


Dim TestNumber As Integer = 45600
' Returns "45,600.00".
Dim TestString As String = FormatNumber(TestNumber, 2, , , TriState.True)


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft